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*[,spindles=*VAL*] \| adopt=*LV*}[,options...]
32 | \| {size=*VAL*,provider=*PROVIDER*}[,param=*value*... ][,options...]
33 | \| {-s|\--os-size} *SIZE*}
34 | [\--no-ip-check] [\--no-name-check] [\--no-conflicts-check]
35 | [\--no-start] [\--no-install]
36 | [\--net=*N* [:options...] \| \--no-nics]
37 | [{-B|\--backend-parameters} *BEPARAMS*]
38 | [{-H|\--hypervisor-parameters} *HYPERVISOR* [: option=*value*... ]]
39 | [{-O|\--os-parameters} *param*=*value*... ]
40 | [\--file-storage-dir *dir\_path*] [\--file-driver {loop \| blktap \| blktap2}]
41 | {{-n|\--node} *node[:secondary-node]* \| {-I|\--iallocator} *name*}
42 | {{-o|\--os-type} *os-type*}
43 | [\--submit] [\--print-job-id]
47 Creates a new instance on the specified host. The *instance* argument
48 must be in DNS, but depending on the bridge/routing setup, need not be
49 in the same network as the nodes in the cluster.
51 The ``disk`` option specifies the parameters for the disks of the
52 instance. The numbering of disks starts at zero, and at least one disk
53 needs to be passed. For each disk, either the size or the adoption
54 source needs to be given. The size is interpreted (when no unit is
55 given) in mebibytes. You can also use one of the suffixes *m*, *g* or
56 *t* to specify the exact the units used; these suffixes map to
57 mebibytes, gibibytes and tebibytes. Each disk can also take these
58 parameters (all optional):
61 How many spindles (physical disks on the node) the disk should span.
64 The access mode. Either ``ro`` (read-only) or the default ``rw``
68 This option specifies a name for the disk, which can be used as a disk
69 identifier. An instance can not have two disks with the same name.
72 The LVM volume group. This works only for LVM and DRBD devices.
75 This options specifies a different VG for the metadata device. This
76 works only for DRBD devices
78 When creating ExtStorage disks, also arbitrary parameters can be passed,
79 to the ExtStorage provider. Those parameters are passed as additional
80 comma separated options. Therefore, an ExtStorage disk provided by
81 provider ``pvdr1`` with parameters ``param1``, ``param2`` would be
82 passed as ``--disk 0:size=10G,provider=pvdr1,param1=val1,param2=val2``.
84 When using the ``adopt`` key in the disk definition, Ganeti will
85 reuse those volumes (instead of creating new ones) as the
86 instance's disks. Ganeti will rename these volumes to the standard
87 format, and (without installing the OS) will use them as-is for the
88 instance. This allows migrating instances from non-managed mode
89 (e.g. plain KVM with LVM) to being managed via Ganeti. Please note that
90 this works only for the \`plain' disk template (see below for
93 Alternatively, a single-disk instance can be created via the ``-s``
94 option which takes a single argument, the size of the disk. This is
95 similar to the Ganeti 1.2 version (but will only create one disk).
97 The minimum disk specification is therefore ``--disk 0:size=20G`` (or
98 ``-s 20G`` when using the ``-s`` option), and a three-disk instance
99 can be specified as ``--disk 0:size=20G --disk 1:size=4G --disk
102 The minimum information needed to specify an ExtStorage disk are the
103 ``size`` and the ``provider``. For example:
104 ``--disk 0:size=20G,provider=pvdr1``.
106 The ``--no-ip-check`` skips the checks that are done to see if the
107 instance's IP is not already alive (i.e. reachable from the master
110 The ``--no-name-check`` skips the check for the instance name via
111 the resolver (e.g. in DNS or /etc/hosts, depending on your setup).
112 Since the name check is used to compute the IP address, if you pass
113 this option you must also pass the ``--no-ip-check`` option.
115 If you don't want the instance to automatically start after
116 creation, this is possible via the ``--no-start`` option. This will
117 leave the instance down until a subsequent **gnt-instance start**
120 The NICs of the instances can be specified via the ``--net``
121 option. By default, one NIC is created for the instance, with a
122 random MAC, and set up according the the cluster level NIC
123 parameters. Each NIC can take these parameters (all optional):
126 either a value or 'generate' to generate a new unique MAC
129 specifies the IP address assigned to the instance from the Ganeti
130 side (this is not necessarily what the instance will use, but what
131 the node expects the instance to use). Note that if an IP in the
132 range of a network configured with **gnt-network**\(8) is used,
133 and the NIC is not already connected to it, this network has to be
134 passed in the **network** parameter if this NIC is meant to be
135 connected to the said network. ``--no-conflicts-check`` can be used
136 to override this check. The special value **pool** causes Ganeti to
137 select an IP from the the network the NIC is or will be connected to.
140 specifies the connection mode for this NIC: routed, bridged or
144 in bridged or openvswitch mode specifies the interface to attach
145 this NIC to, in routed mode it's intended to differentiate between
146 different routing tables/instance groups (but the meaning is
147 dependent on the network script, see **gnt-cluster**\(8) for more
148 details). Note that openvswitch support is also hypervisor
152 derives the mode and the link from the settings of the network
153 which is identified by its name. If the network option is chosen,
154 link and mode must not be specified. Note that the mode and link
155 depend on the network-to-nodegroup connection, thus allowing
156 different nodegroups to be connected to the same network in
160 this option specifies a name for the NIC, which can be used as a NIC
161 identifier. An instance can not have two NICs with the same name.
164 Of these "mode" and "link" are NIC parameters, and inherit their
165 default at cluster level. Alternatively, if no network is desired for
166 the instance, you can prevent the default of one NIC with the
167 ``--no-nics`` option.
169 The ``-o (--os-type)`` option specifies the operating system to be
170 installed. The available operating systems can be listed with
171 **gnt-os list**. Passing ``--no-install`` will however skip the OS
172 installation, allowing a manual import if so desired. Note that the
173 no-installation mode will automatically disable the start-up of the
174 instance (without an OS, it most likely won't be able to start-up
177 The ``-B (--backend-parameters)`` option specifies the backend
178 parameters for the instance. If no such parameters are specified, the
179 values are inherited from the cluster. Possible parameters are:
182 the maximum memory size of the instance; as usual, suffixes can be
183 used to denote the unit, otherwise the value is taken in mebibytes
186 the minimum memory size of the instance; as usual, suffixes can be
187 used to denote the unit, otherwise the value is taken in mebibytes
190 the number of VCPUs to assign to the instance (if this value makes
191 sense for the hypervisor)
194 whether the instance is considered in the N+1 cluster checks
195 (enough redundancy in the cluster to survive a node failure)
198 ``True`` or ``False``, whether the instance must be failed over
199 (shut down and rebooted) always or it may be migrated (briefly
202 Note that before 2.6 Ganeti had a ``memory`` parameter, which was the
203 only value of memory an instance could have. With the
204 ``maxmem``/``minmem`` change Ganeti guarantees that at least the minimum
205 memory is always available for an instance, but allows more memory to be
206 used (up to the maximum memory) should it be free.
208 The ``-H (--hypervisor-parameters)`` option specified the hypervisor
209 to use for the instance (must be one of the enabled hypervisors on the
210 cluster) and optionally custom parameters for this instance. If not
211 other options are used (i.e. the invocation is just -H *NAME*) the
212 instance will inherit the cluster options. The defaults below show the
213 cluster defaults at cluster creation time.
215 The possible hypervisor options are as follows:
218 Valid for the Xen HVM and KVM hypervisors.
220 A string value denoting the boot order. This has different meaning
221 for the Xen HVM hypervisor and for the KVM one.
223 For Xen HVM, The boot order is a string of letters listing the boot
224 devices, with valid device letters being:
238 The default is not to set an HVM boot order, which is interpreted
241 For KVM the boot order is either "floppy", "cdrom", "disk" or
242 "network". Please note that older versions of KVM couldn't netboot
243 from virtio interfaces. This has been fixed in more recent versions
244 and is confirmed to work at least with qemu-kvm 0.11.1. Also note
245 that if you have set the ``kernel_path`` option, that will be used
246 for booting, and this setting will be silently ignored.
249 Valid for the Xen HVM and PVM hypervisors.
251 Relevant to non-pvops guest kernels, in which the disk device names
252 are given by the host. Allows one to specify 'xvd', which helps run
253 Red Hat based installers, driven by anaconda.
256 Valid for the KVM hypervisor.
258 The path to a floppy disk image to attach to the instance. This
259 is useful to install Windows operating systems on Virt/IO disks
260 because you can specify here the floppy for the drivers at
264 Valid for the Xen HVM and KVM hypervisors.
266 The path to a CDROM image to attach to the instance.
269 Valid for the KVM hypervisor.
271 The path to a second CDROM image to attach to the instance.
272 **NOTE**: This image can't be used to boot the system. To do that
273 you have to use the 'cdrom\_image\_path' option.
276 Valid for the Xen HVM and KVM hypervisors.
278 This parameter determines the way the network cards are presented
279 to the instance. The possible options are:
281 - rtl8139 (default for Xen HVM) (HVM & KVM)
282 - ne2k\_isa (HVM & KVM)
283 - ne2k\_pci (HVM & KVM)
289 - paravirtual (default for KVM) (HVM & KVM)
292 Valid for the Xen HVM hypervisor.
294 This parameter specifies the vif type of the nic configuration
295 of the instance. Unsetting the value leads to no type being specified
296 in the configuration. Note that this parameter only takes effect when
297 the 'nic_type' is not set. The possible options are:
303 Valid for the Xen HVM and KVM hypervisors.
305 This parameter determines the way the disks are presented to the
306 instance. The possible options are:
308 - ioemu [default] (HVM & KVM)
309 - paravirtual (HVM & KVM)
318 Valid for the KVM hypervisor.
320 This parameter determines the way the cdroms disks are presented
321 to the instance. The default behavior is to get the same value of
322 the earlier parameter (disk_type). The possible options are:
333 Valid for the Xen HVM and KVM hypervisors.
335 Specifies the address that the VNC listener for this instance
336 should bind to. Valid values are IPv4 addresses. Use the address
337 0.0.0.0 to bind to all available interfaces (this is the default)
338 or specify the address of one of the interfaces on the node to
339 restrict listening to that interface.
342 Valid for the Xen HVM and KVM hypervisors.
344 Specifies the location of the file containing the password for
345 connections using VNC. The default is a file named
346 vnc-cluster-password which can be found in the configuration
350 Valid for the KVM hypervisor.
352 A boolean option that controls whether the VNC connection is
356 Valid for the KVM hypervisor.
358 If ``vnc_tls`` is enabled, this options specifies the path to the
359 x509 certificate to use.
362 Valid for the KVM hypervisor.
365 Valid for the KVM hypervisor.
367 Specifies the address or interface on which the SPICE server will
368 listen. Valid values are:
370 - IPv4 addresses, including 0.0.0.0 and 127.0.0.1
371 - IPv6 addresses, including :: and ::1
372 - names of network interfaces
374 If a network interface is specified, the SPICE server will be bound
375 to one of the addresses of that interface.
378 Valid for the KVM hypervisor.
380 Specifies which version of the IP protocol should be used by the
383 It is mainly intended to be used for specifying what kind of IP
384 addresses should be used if a network interface with both IPv4 and
385 IPv6 addresses is specified via the ``spice_bind`` parameter. In
386 this case, if the ``spice_ip_version`` parameter is not used, the
387 default IP version of the cluster will be used.
389 spice\_password\_file
390 Valid for the KVM hypervisor.
392 Specifies a file containing the password that must be used when
393 connecting via the SPICE protocol. If the option is not specified,
394 passwordless connections are allowed.
396 spice\_image\_compression
397 Valid for the KVM hypervisor.
399 Configures the SPICE lossless image compression. Valid values are:
408 spice\_jpeg\_wan\_compression
409 Valid for the KVM hypervisor.
411 Configures how SPICE should use the jpeg algorithm for lossy image
412 compression on slow links. Valid values are:
418 spice\_zlib\_glz\_wan\_compression
419 Valid for the KVM hypervisor.
421 Configures how SPICE should use the zlib-glz algorithm for lossy image
422 compression on slow links. Valid values are:
428 spice\_streaming\_video
429 Valid for the KVM hypervisor.
431 Configures how SPICE should detect video streams. Valid values are:
437 spice\_playback\_compression
438 Valid for the KVM hypervisor.
440 Configures whether SPICE should compress audio streams or not.
443 Valid for the KVM hypervisor.
445 Specifies that the SPICE server must use TLS to encrypt all the
446 traffic with the client.
449 Valid for the KVM hypervisor.
451 Specifies a list of comma-separated ciphers that SPICE should use
452 for TLS connections. For the format, see man **cipher**\(1).
455 Valid for the KVM hypervisor.
457 Enables or disables passing mouse events via SPICE vdagent.
460 Valid for the KVM hypervisor.
462 This parameter determines the emulated cpu for the instance. If this
463 parameter is empty (which is the default configuration), it will not
466 Be aware of setting this parameter to ``"host"`` if you have nodes
467 with different CPUs from each other. Live migration may stop working
470 For more information please refer to the KVM manual.
473 Valid for the Xen HVM and KVM hypervisors.
475 A boolean option that specifies if the hypervisor should enable
476 ACPI support for this instance. By default, ACPI is disabled.
479 Valid for the Xen HVM and KVM hypervisors.
481 A boolean option that specifies if the hypervisor should enable
482 PAE support for this instance. The default is false, disabling PAE
486 Valid for the Xen HVM hypervisor.
488 A boolean option that specifies if the hypervisor should enable
489 viridian (Hyper-V) for this instance. The default is false,
490 disabling viridian support.
493 Valid for the Xen HVM and KVM hypervisors.
495 A boolean option that specifies if the instance should be started
496 with its clock set to the localtime of the machine (when true) or
497 to the UTC (When false). The default is false, which is useful for
498 Linux/Unix machines; for Windows OSes, it is recommended to enable
502 Valid for the Xen PVM and KVM hypervisors.
504 This option specifies the path (on the node) to the kernel to boot
505 the instance with. Xen PVM instances always require this, while for
506 KVM if this option is empty, it will cause the machine to load the
507 kernel from its disks (and the boot will be done accordingly to
511 Valid for the Xen PVM and KVM hypervisors.
513 This options specifies extra arguments to the kernel that will be
514 loaded. device. This is always used for Xen PVM, while for KVM it
515 is only used if the ``kernel_path`` option is also specified.
517 The default setting for this value is simply ``"ro"``, which
518 mounts the root disk (initially) in read-only one. For example,
519 setting this to single will cause the instance to start in
523 Valid for the Xen PVM and KVM hypervisors.
525 This option specifies the path (on the node) to the initrd to boot
526 the instance with. Xen PVM instances can use this always, while
527 for KVM if this option is only used if the ``kernel_path`` option
528 is also specified. You can pass here either an absolute filename
529 (the path to the initrd) if you want to use an initrd, or use the
530 format no\_initrd\_path for no initrd.
533 Valid for the Xen PVM and KVM hypervisors.
535 This options specifies the name of the root device. This is always
536 needed for Xen PVM, while for KVM it is only used if the
537 ``kernel_path`` option is also specified.
539 Please note, that if this setting is an empty string and the
540 hypervisor is Xen it will not be written to the Xen configuration
544 Valid for the KVM hypervisor.
546 This boolean option specifies whether to emulate a serial console
547 for the instance. Note that some versions of KVM have a bug that
548 will make an instance hang when configured to use the serial console
549 unless a connection is made to it within about 2 seconds of the
550 instance's startup. For such case it's recommended to disable this
551 option, which is enabled by default.
554 Valid for the KVM hypervisor.
556 This integer option specifies the speed of the serial console.
557 Common values are 9600, 19200, 38400, 57600 and 115200: choose the
558 one which works on your system. (The default is 38400 for historical
559 reasons, but newer versions of kvm/qemu work with 115200)
562 Valid for the KVM hypervisor.
564 The disk cache mode. It can be either default to not pass any
565 cache option to KVM, or one of the KVM cache modes: none (for
566 direct I/O), writethrough (to use the host cache but report
567 completion to the guest only when the host has committed the
568 changes to disk) or writeback (to use the host cache and report
569 completion as soon as the data is in the host cache). Note that
570 there are special considerations for the cache mode depending on
571 version of KVM used and disk type (always raw file under Ganeti),
572 please refer to the KVM documentation for more details.
575 Valid for the KVM hypervisor.
577 The security model for kvm. Currently one of *none*, *user* or
578 *pool*. Under *none*, the default, nothing is done and instances
579 are run as the Ganeti daemon user (normally root).
581 Under *user* kvm will drop privileges and become the user
582 specified by the security\_domain parameter.
584 Under *pool* a global cluster pool of users will be used, making
585 sure no two instances share the same user on the same node. (this
586 mode is not implemented yet)
589 Valid for the KVM hypervisor.
591 Under security model *user* the username to run the instance
592 under. It must be a valid username existing on the host.
594 Cannot be set under security model *none* or *pool*.
597 Valid for the KVM hypervisor.
599 If *enabled* the -enable-kvm flag is passed to kvm. If *disabled*
600 -disable-kvm is passed. If unset no flag is passed, and the
601 default running mode for your kvm binary will be used.
604 Valid for the KVM hypervisor.
606 This option passes the -mem-path argument to kvm with the path (on
607 the node) to the mount point of the hugetlbfs file system, along
608 with the -mem-prealloc argument too.
611 Valid for the KVM hypervisor.
613 This boolean option determines whether to run the KVM instance in a
616 If it is set to ``true``, an empty directory is created before
617 starting the instance and its path is passed via the -chroot flag
618 to kvm. The directory is removed when the instance is stopped.
620 It is set to ``false`` by default.
623 Valid for the KVM hypervisor.
625 The maximum amount of time (in ms) a KVM instance is allowed to be
626 frozen during a live migration, in order to copy dirty memory
627 pages. Default value is 30ms, but you may need to increase this
628 value for busy instances.
630 This option is only effective with kvm versions >= 87 and qemu-kvm
634 Valid for the Xen, KVM and LXC hypervisors.
636 The processes belonging to the given instance are only scheduled
637 on the specified CPUs.
639 The format of the mask can be given in three forms. First, the word
640 "all", which signifies the common case where all VCPUs can live on
641 any CPU, based on the hypervisor's decisions.
643 Second, a comma-separated list of CPU IDs or CPU ID ranges. The
644 ranges are defined by a lower and higher boundary, separated by a
645 dash, and the boundaries are inclusive. In this form, all VCPUs of
646 the instance will be mapped on the selected list of CPUs. Example:
647 ``0-2,5``, mapping all VCPUs (no matter how many) onto physical CPUs
650 The last form is used for explicit control of VCPU-CPU pinnings. In
651 this form, the list of VCPU mappings is given as a colon (:)
652 separated list, whose elements are the possible values for the
653 second or first form above. In this form, the number of elements in
654 the colon-separated list _must_ equal the number of VCPUs of the
661 # Map the entire instance to CPUs 0-2
662 gnt-instance modify -H cpu_mask=0-2 my-inst
664 # Map vCPU 0 to physical CPU 1 and vCPU 1 to CPU 3 (assuming 2 vCPUs)
665 gnt-instance modify -H cpu_mask=1:3 my-inst
667 # Pin vCPU 0 to CPUs 1 or 2, and vCPU 1 to any CPU
668 gnt-instance modify -H cpu_mask=1-2:all my-inst
670 # Pin vCPU 0 to any CPU, vCPU 1 to CPUs 1, 3, 4 or 5, and CPU 2 to
671 # CPU 0 (backslashes for escaping the comma)
672 gnt-instance modify -H cpu_mask=all:1\\,3-5:0 my-inst
674 # Pin entire VM to CPU 0
675 gnt-instance modify -H cpu_mask=0 my-inst
677 # Turn off CPU pinning (default setting)
678 gnt-instance modify -H cpu_mask=all my-inst
681 Valid for the Xen hypervisor.
683 Set the maximum amount of cpu usage by the VM. The value is a percentage
684 between 0 and (100 * number of VCPUs). Default cap is 0: unlimited.
687 Valid for the Xen hypervisor.
689 Set the cpu time ratio to be allocated to the VM. Valid values are
690 between 1 and 65535. Default weight is 256.
693 Valid for the KVM hypervisor.
695 This option specifies the usb mouse type to be used. It can be
696 "mouse" or "tablet". When using VNC it's recommended to set it to
700 Valid for the KVM hypervisor.
702 This option specifies the keyboard mapping to be used. It is only
703 needed when using the VNC console. For example: "fr" or "en-gb".
706 Valid for Xen PVM, Xen HVM and KVM hypervisors.
708 Normally if an instance reboots, the hypervisor will restart it. If
709 this option is set to ``exit``, the hypervisor will treat a reboot
710 as a shutdown instead.
712 It is set to ``reboot`` by default.
715 Valid for the KVM hypervisor.
717 Number of emulated CPU cores.
720 Valid for the KVM hypervisor.
722 Number of emulated CPU threads.
725 Valid for the KVM hypervisor.
727 Number of emulated CPU sockets.
730 Valid for the KVM hypervisor.
732 Comma separated list of emulated sounds cards, or "all" to enable
733 all the available ones.
736 Valid for the KVM hypervisor.
738 Space separated list of usb devices. These can be emulated devices
739 or passthrough ones, and each one gets passed to kvm with its own
740 ``-usbdevice`` option. See the **qemu**\(1) manpage for the syntax
741 of the possible components. Note that values set with this
742 parameter are split on a space character and currently don't support
743 quoting. For backwards compatibility reasons, the RAPI interface keeps
744 accepting comma separated lists too.
747 Valid for the KVM hypervisor.
749 Emulated vga mode, passed the the kvm -vga option.
752 Valid for the KVM hypervisor.
754 Any other option to the KVM hypervisor, useful tweaking anything
755 that Ganeti doesn't support. Note that values set with this
756 parameter are split on a space character and currently don't support
760 Valid for the KVM hypervisor.
762 Use in case an instance must be booted with an exact type of
763 machine version (due to e.g. outdated drivers). In case it's not set
764 the default version supported by your version of kvm is used.
767 Valid for the KVM hypervisor.
769 Path to the userspace KVM (or qemu) program.
772 Valid for the KVM hypervisor.
774 This boolean option determines whether the tap devices used by the
775 KVM paravirtual nics (virtio-net) will get created with VNET_HDR
776 (IFF_VNET_HDR) support.
778 If set to false, it effectively disables offloading on the virio-net
779 interfaces, which prevents host kernel tainting and log flooding,
780 when dealing with broken or malicious virtio-net drivers.
782 It is set to ``true`` by default.
784 The ``-O (--os-parameters)`` option allows customisation of the OS
785 parameters. The actual parameter names and values depends on the OS
786 being used, but the syntax is the same key=value. For example, setting
787 a hypothetical ``dhcp`` parameter to yes can be achieved by::
789 gnt-instance add -O dhcp=yes ...
791 The ``-I (--iallocator)`` option specifies the instance allocator plugin
792 to use (``.`` means the default allocator). If you pass in this option
793 the allocator will select nodes for this instance automatically, so you
794 don't need to pass them with the ``-n`` option. For more information
795 please refer to the instance allocator documentation.
797 The ``-t (--disk-template)`` options specifies the disk layout type
798 for the instance. If no disk template is specified, the default disk
799 template is used. The default disk template is the first in the list
800 of enabled disk templates, which can be adjusted cluster-wide with
801 ``gnt-cluster modify``. The available choices for disk templates are:
804 This creates an instance with no disks. Its useful for testing only
805 (or other special cases).
808 Disk devices will be regular files.
811 Disk devices will be regulare files on a shared directory.
814 Disk devices will be logical volumes.
817 Disk devices will be drbd (version 8.x) on top of lvm volumes.
820 Disk devices will be rbd volumes residing inside a RADOS cluster.
823 Disk devices will be adopted pre-existent block devices.
826 Disk devices will be provided by external shared storage,
827 through the ExtStorage Interface using ExtStorage providers.
829 The optional second value of the ``-n (--node)`` is used for the drbd
830 template type and specifies the remote node.
832 If you do not want gnt-instance to wait for the disk mirror to be
833 synced, use the ``--no-wait-for-sync`` option.
835 The ``--file-storage-dir`` specifies the relative path under the
836 cluster-wide file storage directory to store file-based disks. It is
837 useful for having different subdirectories for different
838 instances. The full path of the directory where the disk files are
839 stored will consist of cluster-wide file storage directory + optional
840 subdirectory + instance name. This option is only relevant for
841 instances using the file storage backend.
843 The ``--file-driver`` specifies the driver to use for file-based
844 disks. Note that currently these drivers work with the xen hypervisor
845 only. This option is only relevant for instances using the file
846 storage backend. The available choices are:
849 Kernel loopback driver. This driver uses loopback devices to
850 access the filesystem within the file. However, running I/O
851 intensive applications in your instance using the loop driver
852 might result in slowdowns. Furthermore, if you use the loopback
853 driver consider increasing the maximum amount of loopback devices
854 (on most systems it's 8) using the max\_loop param.
857 The blktap driver (for Xen hypervisors). In order to be able to
858 use the blktap driver you should check if the 'blktapctrl' user
859 space disk agent is running (usually automatically started via
860 xend). This user-level disk I/O interface has the advantage of
861 better performance. Especially if you use a network file system
862 (e.g. NFS) to store your instances this is the recommended choice.
865 Analogous to the blktap driver, but used by newer versions of Xen.
867 If ``--ignore-ipolicy`` is given any instance policy violations occuring
868 during this operation are ignored.
870 See **ganeti**\(7) for a description of ``--submit`` and other common
875 # gnt-instance add -t file --disk 0:size=30g -B maxmem=512 -o debian-etch \
876 -n node1.example.com --file-storage-dir=mysubdir instance1.example.com
877 # gnt-instance add -t plain --disk 0:size=30g -B maxmem=1024,minmem=512 \
878 -o debian-etch -n node1.example.com instance1.example.com
879 # gnt-instance add -t plain --disk 0:size=30g --disk 1:size=100g,vg=san \
880 -B maxmem=512 -o debian-etch -n node1.example.com instance1.example.com
881 # gnt-instance add -t drbd --disk 0:size=30g -B maxmem=512 -o debian-etch \
882 -n node1.example.com:node2.example.com instance2.example.com
883 # gnt-instance add -t rbd --disk 0:size=30g -B maxmem=512 -o debian-etch \
884 -n node1.example.com instance1.example.com
885 # gnt-instance add -t ext --disk 0:size=30g,provider=pvdr1 -B maxmem=512 \
886 -o debian-etch -n node1.example.com instance1.example.com
887 # gnt-instance add -t ext --disk 0:size=30g,provider=pvdr1,param1=val1 \
888 --disk 1:size=40g,provider=pvdr2,param2=val2,param3=val3 -B maxmem=512 \
889 -o debian-etch -n node1.example.com instance1.example.com
896 | [{-I|\--iallocator} *instance allocator*]
897 | {instances\_file.json}
899 This command (similar to the Ganeti 1.2 **batcher** tool) submits
900 multiple instance creation jobs based on a definition file. This
901 file can contain all options which are valid when adding an instance
902 with the exception of the ``iallocator`` field. The IAllocator is,
903 for optimization purposes, only allowed to be set for the whole batch
904 operation using the ``--iallocator`` parameter.
906 The instance file must be a valid-formed JSON file, containing an
907 array of dictionaries with instance creation parameters. All parameters
908 (except ``iallocator``) which are valid for the instance creation
909 OP code are allowed. The most important ones are:
912 The FQDN of the new instance.
915 The disk template to use for the instance, the same as in the
919 Array of disk specifications. Each entry describes one disk as a
920 dictionary of disk parameters.
923 A dictionary of backend parameters.
926 The hypervisor for the instance.
929 A dictionary with the hypervisor options. If not passed, the default
930 hypervisor options will be inherited.
933 List of NICs that will be created for the instance. Each entry
934 should be a dict, with mac, ip, mode and link as possible keys.
935 Please don't provide the "mac, ip, mode, link" parent keys if you
936 use this method for specifying NICs.
939 The primary and optionally the secondary node to use for the
940 instance (in case an iallocator script is not used). If those
941 parameters are given, they have to be given consistently for all
942 instances in the batch operation.
945 whether to start the instance
948 Skip the check for already-in-use instance; see the description in
949 the **add** command for details.
952 Skip the name check for instances; see the description in the
953 **add** command for details.
955 file\_storage\_dir, file\_driver
956 Configuration for the file disk type, see the **add** command for
960 A simple definition for one instance can be (with most of the
961 parameters taken from the cluster defaults)::
966 "instance_name": "instance1.example.com",
967 "disk_template": "drbd",
968 "os_type": "debootstrap",
969 "disks": [{"size":"1024"}],
971 "hypervisor": "xen-pvm"
975 "instance_name": "instance2.example.com",
976 "disk_template": "drbd",
977 "os_type": "debootstrap",
978 "disks": [{"size":"4096", "mode": "rw", "vg": "xenvg"}],
980 "hypervisor": "xen-hvm",
981 "hvparams": {"acpi": true},
982 "beparams": {"maxmem": 512, "minmem": 256}
986 The command will display the job id for each submitted instance, as
989 # gnt-instance batch-create instances.json
990 Submitted jobs 37, 38
995 | **remove** [\--ignore-failures] [\--shutdown-timeout=*N*] [\--submit]
996 | [\--print-job-id] [\--force] {*instance*}
998 Remove an instance. This will remove all data from the instance and
999 there is *no way back*. If you are not sure if you use an instance
1000 again, use **shutdown** first and leave it in the shutdown state for a
1003 The ``--ignore-failures`` option will cause the removal to proceed
1004 even in the presence of errors during the removal of the instance
1005 (e.g. during the shutdown or the disk removal). If this option is not
1006 given, the command will stop at the first error.
1008 The ``--shutdown-timeout`` is used to specify how much time to wait
1009 before forcing the shutdown (e.g. ``xm destroy`` in Xen, killing the
1010 kvm process for KVM, etc.). By default two minutes are given to each
1013 The ``--force`` option is used to skip the interactive confirmation.
1015 See **ganeti**\(7) for a description of ``--submit`` and other common
1020 # gnt-instance remove instance1.example.com
1027 | [\--no-headers] [\--separator=*SEPARATOR*] [\--units=*UNITS*] [-v]
1028 | [{-o|\--output} *[+]FIELD,...*] [\--filter] [instance...]
1030 Shows the currently configured instances with memory usage, disk
1031 usage, the node they are running on, and their run status.
1033 The ``--no-headers`` option will skip the initial header line. The
1034 ``--separator`` option takes an argument which denotes what will be
1035 used between the output fields. Both these options are to help
1038 The units used to display the numeric values in the output varies,
1039 depending on the options given. By default, the values will be
1040 formatted in the most appropriate unit. If the ``--separator`` option
1041 is given, then the values are shown in mebibytes to allow parsing by
1042 scripts. In both cases, the ``--units`` option can be used to enforce
1043 a given output unit.
1045 The ``-v`` option activates verbose mode, which changes the display of
1046 special field states (see **ganeti**\(7)).
1048 The ``-o (--output)`` option takes a comma-separated list of output
1049 fields. The available fields and their meaning are:
1051 @QUERY_FIELDS_INSTANCE@
1053 If the value of the option starts with the character ``+``, the new
1054 field(s) will be added to the default list. This allows one to quickly
1055 see the default list plus a few other fields, instead of retyping the
1056 entire list of fields.
1058 There is a subtle grouping about the available output fields: all
1059 fields except for ``oper_state``, ``oper_ram``, ``oper_vcpus`` and
1060 ``status`` are configuration value and not run-time values. So if you
1061 don't select any of the these fields, the query will be satisfied
1062 instantly from the cluster configuration, without having to ask the
1063 remote nodes for the data. This can be helpful for big clusters when
1064 you only want some data and it makes sense to specify a reduced set of
1067 If exactly one argument is given and it appears to be a query filter
1068 (see **ganeti**\(7)), the query result is filtered accordingly. For
1069 ambiguous cases (e.g. a single field name as a filter) the ``--filter``
1070 (``-F``) option forces the argument to be treated as a filter (e.g.
1071 ``gnt-instance list -F admin_state``).
1073 The default output field list is: ``name``, ``os``, ``pnode``,
1074 ``admin_state``, ``oper_state``, ``oper_ram``.
1080 **list-fields** [field...]
1082 Lists available fields for instances.
1088 **info** [-s \| \--static] [\--roman] {\--all \| *instance*}
1090 Show detailed information about the given instance(s). This is
1091 different from **list** as it shows detailed data about the instance's
1092 disks (especially useful for the drbd disk template).
1094 If the option ``-s`` is used, only information available in the
1095 configuration file is returned, without querying nodes, making the
1098 Use the ``--all`` to get info about all instances, rather than
1099 explicitly passing the ones you're interested in.
1101 The ``--roman`` option can be used to cause envy among people who like
1102 ancient cultures, but are stuck with non-latin-friendly cluster
1103 virtualization technologies.
1109 | [{-H|\--hypervisor-parameters} *HYPERVISOR\_PARAMETERS*]
1110 | [{-B|\--backend-parameters} *BACKEND\_PARAMETERS*]
1111 | [{-m|\--runtime-memory} *SIZE*]
1112 | [\--net add[:options...] \|
1113 | \--net [*N*:]add[,options...] \|
1114 | \--net [*ID*:]remove \|
1115 | \--net *ID*:modify[,options...]]
1116 | [\--disk add:size=*SIZE*[,options...] \|
1117 | \--disk *N*:add,size=*SIZE*[,options...] \|
1118 | \--disk *N*:add,size=*SIZE*,provider=*PROVIDER*[,options...][,param=*value*... ] \|
1119 | \--disk *ID*:modify[,options...]
1120 | \--disk [*ID*:]remove]
1121 | [{-t|\--disk-template} plain \| {-t|\--disk-template} drbd -n *new_secondary*] [\--no-wait-for-sync]
1122 | [\--new-primary=*node*]
1123 | [\--os-type=*OS* [\--force-variant]]
1124 | [{-O|\--os-parameters} *param*=*value*... ]
1125 | [\--offline \| \--online]
1126 | [\--submit] [\--print-job-id]
1127 | [\--ignore-ipolicy]
1130 Modifies the memory size, number of vcpus, ip address, MAC address
1131 and/or NIC parameters for an instance. It can also add and remove
1132 disks and NICs to/from the instance. Note that you need to give at
1133 least one of the arguments, otherwise the command complains.
1135 The ``-H (--hypervisor-parameters)``, ``-B (--backend-parameters)``
1136 and ``-O (--os-parameters)`` options specifies hypervisor, backend and
1137 OS parameter options in the form of name=value[,...]. For details
1138 which options can be specified, see the **add** command.
1140 The ``-t (--disk-template)`` option will change the disk template of
1141 the instance. Currently only conversions between the plain and drbd
1142 disk templates are supported, and the instance must be stopped before
1143 attempting the conversion. When changing from the plain to the drbd
1144 disk template, a new secondary node must be specified via the ``-n``
1145 option. The option ``--no-wait-for-sync`` can be used when converting
1146 to the ``drbd`` template in order to make the instance available for
1147 startup before DRBD has finished resyncing.
1149 The ``-m (--runtime-memory)`` option will change an instance's runtime
1150 memory to the given size (in MB if a different suffix is not specified),
1151 by ballooning it up or down to the new value.
1153 The ``--disk add:size=*SIZE*,[options..]`` option adds a disk to the
1154 instance, and ``--disk *N*:add:size=*SIZE*,[options..]`` will add a disk
1155 to the the instance at a specific index. The available options are the
1156 same as in the **add** command(``spindles``, ``mode``, ``name``, ``vg``,
1157 ``metavg``). When adding an ExtStorage disk the ``provider=*PROVIDER*``
1158 option is also mandatory and specifies the ExtStorage provider. Also,
1159 for ExtStorage disks arbitrary parameters can be passed as additional
1160 comma separated options, same as in the **add** command. -The ``--disk
1161 remove`` option will remove the last disk of the instance. Use ``--disk
1162 `` *ID*``:remove`` to remove a disk by its identifier. *ID* can be the
1163 index of the disk, the disks's name or the disks's UUID. The ``--disk
1164 *ID*:modify[,options...]`` will change the options of the disk.
1165 Available options are:
1168 The access mode. Either ``ro`` (read-only) or the default ``rw`` (read-write).
1171 This option specifies a name for the disk, which can be used as a disk
1172 identifier. An instance can not have two disks with the same name.
1174 The ``--net *N*:add[,options..]`` will add a new network interface to
1175 the instance. The available options are the same as in the **add**
1176 command (``mac``, ``ip``, ``link``, ``mode``, ``network``). The
1177 ``--net *ID*,remove`` will remove the intances' NIC with *ID* identifier,
1178 which can be the index of the NIC, the NIC's name or the NIC's UUID.
1179 The ``--net *ID*:modify[,options..]`` option will change the parameters of
1180 the instance network interface with the *ID* identifier.
1182 The option ``-o (--os-type)`` will change the OS name for the instance
1183 (without reinstallation). In case an OS variant is specified that is
1184 not found, then by default the modification is refused, unless
1185 ``--force-variant`` is passed. An invalid OS will also be refused,
1186 unless the ``--force`` option is given.
1188 The option ``--new-primary`` will set the new primary node of an instance
1189 assuming the disks have already been moved manually. Unless the ``--force``
1190 option is given, it is verified that the instance is no longer running
1191 on its current primary node.
1193 The ``--online`` and ``--offline`` options are used to transition an
1194 instance into and out of the ``offline`` state. An instance can be
1195 turned offline only if it was previously down. The ``--online`` option
1196 fails if the instance was not in the ``offline`` state, otherwise it
1197 changes instance's state to ``down``. These modifications take effect
1200 If ``--ignore-ipolicy`` is given any instance policy violations occuring
1201 during this operation are ignored.
1203 See **ganeti**\(7) for a description of ``--submit`` and other common
1206 Most of the changes take effect at the next restart. If the instance is
1207 running, there is no effect on the instance.
1212 | **reinstall** [{-o|\--os-type} *os-type*] [\--select-os] [-f *force*]
1213 | [\--force-multiple]
1214 | [\--instance \| \--node \| \--primary \| \--secondary \| \--all]
1215 | [{-O|\--os-parameters} *OS\_PARAMETERS*] [\--submit] [\--print-job-id]
1218 Reinstalls the operating system on the given instance(s). The
1219 instance(s) must be stopped when running this command. If the ``-o
1220 (--os-type)`` is specified, the operating system is changed.
1222 The ``--select-os`` option switches to an interactive OS reinstall.
1223 The user is prompted to select the OS template from the list of
1224 available OS templates. OS parameters can be overridden using ``-O
1225 (--os-parameters)`` (more documentation for this option under the
1228 Since this is a potentially dangerous command, the user will be
1229 required to confirm this action, unless the ``-f`` flag is passed.
1230 When multiple instances are selected (either by passing multiple
1231 arguments or by using the ``--node``, ``--primary``, ``--secondary``
1232 or ``--all`` options), the user must pass the ``--force-multiple``
1233 options to skip the interactive confirmation.
1235 See **ganeti**\(7) for a description of ``--submit`` and other common
1241 | **rename** [\--no-ip-check] [\--no-name-check] [\--submit] [\--print-job-id]
1242 | {*instance*} {*new\_name*}
1244 Renames the given instance. The instance must be stopped when running
1245 this command. The requirements for the new name are the same as for
1246 adding an instance: the new name must be resolvable and the IP it
1247 resolves to must not be reachable (in order to prevent duplicate IPs
1248 the next time the instance is started). The IP test can be skipped if
1249 the ``--no-ip-check`` option is passed.
1251 Note that you can rename an instance to its same name, to force
1252 re-executing the os-specific rename script for that instance, if
1255 The ``--no-name-check`` skips the check for the new instance name via
1256 the resolver (e.g. in DNS or /etc/hosts, depending on your setup) and
1257 that the resolved name matches the provided name. Since the name check
1258 is used to compute the IP address, if you pass this option you must also
1259 pass the ``--no-ip-check`` option.
1261 See **ganeti**\(7) for a description of ``--submit`` and other common
1264 Starting/stopping/connecting to console
1265 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1271 | [\--force] [\--ignore-offline]
1272 | [\--force-multiple] [\--no-remember]
1273 | [\--instance \| \--node \| \--primary \| \--secondary \| \--all \|
1274 | \--tags \| \--node-tags \| \--pri-node-tags \| \--sec-node-tags]
1275 | [{-H|\--hypervisor-parameters} ``key=value...``]
1276 | [{-B|\--backend-parameters} ``key=value...``]
1277 | [\--submit] [\--print-job-id] [\--paused]
1280 Starts one or more instances, depending on the following options. The
1281 four available modes are:
1284 will start the instances given as arguments (at least one argument
1285 required); this is the default selection
1288 will start the instances who have the given node as either primary
1292 will start all instances whose primary node is in the list of nodes
1293 passed as arguments (at least one node required)
1296 will start all instances whose secondary node is in the list of
1297 nodes passed as arguments (at least one node required)
1300 will start all instances in the cluster (no arguments accepted)
1303 will start all instances in the cluster with the tags given as
1307 will start all instances in the cluster on nodes with the tags
1311 will start all instances in the cluster on primary nodes with the
1312 tags given as arguments
1315 will start all instances in the cluster on secondary nodes with the
1316 tags given as arguments
1318 Note that although you can pass more than one selection option, the
1319 last one wins, so in order to guarantee the desired result, don't pass
1320 more than one such option.
1322 Use ``--force`` to start even if secondary disks are failing.
1323 ``--ignore-offline`` can be used to ignore offline primary nodes and
1324 mark the instance as started even if the primary is not available.
1326 The ``--force-multiple`` will skip the interactive confirmation in the
1327 case the more than one instance will be affected.
1329 The ``--no-remember`` option will perform the startup but not change
1330 the state of the instance in the configuration file (if it was stopped
1331 before, Ganeti will still think it needs to be stopped). This can be
1332 used for testing, or for a one shot-start where you don't want the
1333 watcher to restart the instance if it crashes.
1335 The ``-H (--hypervisor-parameters)`` and ``-B (--backend-parameters)``
1336 options specify temporary hypervisor and backend parameters that can
1337 be used to start an instance with modified parameters. They can be
1338 useful for quick testing without having to modify an instance back and
1341 # gnt-instance start -H kernel_args="single" instance1
1342 # gnt-instance start -B maxmem=2048 instance2
1345 The first form will start the instance instance1 in single-user mode,
1346 and the instance instance2 with 2GB of RAM (this time only, unless
1347 that is the actual instance memory size already). Note that the values
1348 override the instance parameters (and not extend them): an instance
1349 with "kernel\_args=ro" when started with -H kernel\_args=single will
1350 result in "single", not "ro single".
1352 The ``--paused`` option is only valid for Xen and kvm hypervisors. This
1353 pauses the instance at the start of bootup, awaiting ``gnt-instance
1354 console`` to unpause it, allowing the entire boot process to be
1355 monitored for debugging.
1357 See **ganeti**\(7) for a description of ``--submit`` and other common
1362 # gnt-instance start instance1.example.com
1363 # gnt-instance start --node node1.example.com node2.example.com
1364 # gnt-instance start --all
1372 | [\--force] [\--force-multiple] [\--ignore-offline] [\--no-remember]
1373 | [\--instance \| \--node \| \--primary \| \--secondary \| \--all \|
1374 | \--tags \| \--node-tags \| \--pri-node-tags \| \--sec-node-tags]
1375 | [\--submit] [\--print-job-id]
1378 Stops one or more instances. If the instance cannot be cleanly stopped
1379 during a hardcoded interval (currently 2 minutes), it will forcibly
1380 stop the instance (equivalent to switching off the power on a physical
1383 The ``--timeout`` is used to specify how much time to wait before
1384 forcing the shutdown (e.g. ``xm destroy`` in Xen, killing the kvm
1385 process for KVM, etc.). By default two minutes are given to each
1388 The ``--instance``, ``--node``, ``--primary``, ``--secondary``,
1389 ``--all``, ``--tags``, ``--node-tags``, ``--pri-node-tags`` and
1390 ``--sec-node-tags`` options are similar as for the **startup** command
1391 and they influence the actual instances being shutdown.
1393 ``--ignore-offline`` can be used to ignore offline primary nodes and
1394 force the instance to be marked as stopped. This option should be used
1395 with care as it can lead to an inconsistent cluster state.
1397 Use ``--force`` to be able to shutdown an instance even when it's marked
1398 as offline. This is useful is an offline instance ends up in the
1399 ``ERROR_up`` state, for example.
1401 The ``--no-remember`` option will perform the shutdown but not change
1402 the state of the instance in the configuration file (if it was running
1403 before, Ganeti will still thinks it needs to be running). This can be
1404 useful for a cluster-wide shutdown, where some instances are marked as
1405 up and some as down, and you don't want to change the running state:
1406 you just need to disable the watcher, shutdown all instances with
1407 ``--no-remember``, and when the watcher is activated again it will
1408 restore the correct runtime state for all instances.
1410 See **ganeti**\(7) for a description of ``--submit`` and other common
1415 # gnt-instance shutdown instance1.example.com
1416 # gnt-instance shutdown --all
1423 | [{-t|\--type} *REBOOT-TYPE*]
1424 | [\--ignore-secondaries]
1425 | [\--shutdown-timeout=*N*]
1426 | [\--force-multiple]
1427 | [\--instance \| \--node \| \--primary \| \--secondary \| \--all \|
1428 | \--tags \| \--node-tags \| \--pri-node-tags \| \--sec-node-tags]
1429 | [\--submit] [\--print-job-id]
1432 Reboots one or more instances. The type of reboot depends on the value
1433 of ``-t (--type)``. A soft reboot does a hypervisor reboot, a hard reboot
1434 does a instance stop, recreates the hypervisor config for the instance
1435 and starts the instance. A full reboot does the equivalent of
1436 **gnt-instance shutdown && gnt-instance startup**. The default is
1439 For the hard reboot the option ``--ignore-secondaries`` ignores errors
1440 for the secondary node while re-assembling the instance disks.
1442 The ``--instance``, ``--node``, ``--primary``, ``--secondary``,
1443 ``--all``, ``--tags``, ``--node-tags``, ``--pri-node-tags`` and
1444 ``--sec-node-tags`` options are similar as for the **startup** command
1445 and they influence the actual instances being rebooted.
1447 The ``--shutdown-timeout`` is used to specify how much time to wait
1448 before forcing the shutdown (xm destroy in xen, killing the kvm
1449 process, for kvm). By default two minutes are given to each instance
1452 The ``--force-multiple`` will skip the interactive confirmation in the
1453 case the more than one instance will be affected.
1455 See **ganeti**\(7) for a description of ``--submit`` and other common
1460 # gnt-instance reboot instance1.example.com
1461 # gnt-instance reboot --type=full instance1.example.com
1467 **console** [\--show-cmd] {*instance*}
1469 Connects to the console of the given instance. If the instance is not
1470 up, an error is returned. Use the ``--show-cmd`` option to display the
1471 command instead of executing it.
1473 For HVM instances, this will attempt to connect to the serial console
1474 of the instance. To connect to the virtualized "physical" console of a
1475 HVM instance, use a VNC client with the connection info from the
1478 For Xen/kvm instances, if the instance is paused, this attempts to
1479 unpause the instance after waiting a few seconds for the connection to
1480 the console to be made.
1484 # gnt-instance console instance1.example.com
1493 | **replace-disks** [\--submit] [\--print-job-id] [\--early-release]
1494 | [\--ignore-ipolicy] {-p} [\--disks *idx*] {*instance*}
1496 | **replace-disks** [\--submit] [\--print-job-id] [\--early-release]
1497 | [\--ignore-ipolicy] {-s} [\--disks *idx*] {*instance*}
1499 | **replace-disks** [\--submit] [\--print-job-id] [\--early-release]
1500 | [\--ignore-ipolicy]
1501 | {{-I\|\--iallocator} *name* \| {{-n|\--new-secondary} *node* } {*instance*}
1503 | **replace-disks** [\--submit] [\--print-job-id] [\--early-release]
1504 | [\--ignore-ipolicy] {-a\|\--auto} {*instance*}
1506 This command is a generalized form for replacing disks. It is
1507 currently only valid for the mirrored (DRBD) disk template.
1509 The first form (when passing the ``-p`` option) will replace the disks
1510 on the primary, while the second form (when passing the ``-s`` option
1511 will replace the disks on the secondary node. For these two cases (as
1512 the node doesn't change), it is possible to only run the replace for a
1513 subset of the disks, using the option ``--disks`` which takes a list
1514 of comma-delimited disk indices (zero-based), e.g. 0,2 to replace only
1515 the first and third disks.
1517 The third form (when passing either the ``--iallocator`` or the
1518 ``--new-secondary`` option) is designed to change secondary node of the
1519 instance. Specifying ``--iallocator`` makes the new secondary be
1520 selected automatically by the specified allocator plugin (use ``.`` to
1521 indicate the default allocator), otherwise the new secondary node will
1522 be the one chosen manually via the ``--new-secondary`` option.
1524 Note that it is not possible to select an offline or drained node as a
1527 The fourth form (when using ``--auto``) will automatically determine
1528 which disks of an instance are faulty and replace them within the same
1529 node. The ``--auto`` option works only when an instance has only
1530 faulty disks on either the primary or secondary node; it doesn't work
1531 when both sides have faulty disks.
1533 The ``--early-release`` changes the code so that the old storage on
1534 secondary node(s) is removed early (before the resync is completed)
1535 and the internal Ganeti locks for the current (and new, if any)
1536 secondary node are also released, thus allowing more parallelism in
1537 the cluster operation. This should be used only when recovering from a
1538 disk failure on the current secondary (thus the old storage is already
1539 broken) or when the storage on the primary node is known to be fine
1540 (thus we won't need the old storage for potential recovery).
1542 The ``--ignore-ipolicy`` let the command ignore instance policy
1543 violations if replace-disks changes groups and the instance would
1544 violate the new groups instance policy.
1546 See **ganeti**\(7) for a description of ``--submit`` and other common
1552 | **activate-disks** [\--submit] [\--print-job-id] [\--ignore-size]
1553 | [\--wait-for-sync] {*instance*}
1555 Activates the block devices of the given instance. If successful, the
1556 command will show the location and name of the block devices::
1558 node1.example.com:disk/0:/dev/drbd0
1559 node1.example.com:disk/1:/dev/drbd1
1562 In this example, *node1.example.com* is the name of the node on which
1563 the devices have been activated. The *disk/0* and *disk/1* are the
1564 Ganeti-names of the instance disks; how they are visible inside the
1565 instance is hypervisor-specific. */dev/drbd0* and */dev/drbd1* are the
1566 actual block devices as visible on the node.
1568 The ``--ignore-size`` option can be used to activate disks ignoring
1569 the currently configured size in Ganeti. This can be used in cases
1570 where the configuration has gotten out of sync with the real-world
1571 (e.g. after a partially-failed grow-disk operation or due to rounding
1572 in LVM devices). This should not be used in normal cases, but only
1573 when activate-disks fails without it.
1575 The ``--wait-for-sync`` option will ensure that the command returns only
1576 after the instance's disks are synchronised (mostly for DRBD); this can
1577 be useful to ensure consistency, as otherwise there are no commands that
1578 can wait until synchronisation is done. However when passing this
1579 option, the command will have additional output, making it harder to
1580 parse the disk information.
1582 Note that it is safe to run this command while the instance is already
1585 See **ganeti**\(7) for a description of ``--submit`` and other common
1591 **deactivate-disks** [-f] [\--submit] [\--print-job-id] {*instance*}
1593 De-activates the block devices of the given instance. Note that if you
1594 run this command for an instance with a drbd disk template, while it
1595 is running, it will not be able to shutdown the block devices on the
1596 primary node, but it will shutdown the block devices on the secondary
1597 nodes, thus breaking the replication.
1599 The ``-f``/``--force`` option will skip checks that the instance is
1600 down; in case the hypervisor is confused and we can't talk to it,
1601 normally Ganeti will refuse to deactivate the disks, but with this
1602 option passed it will skip this check and directly try to deactivate
1603 the disks. This can still fail due to the instance actually running or
1606 See **ganeti**\(7) for a description of ``--submit`` and other common
1612 | **grow-disk** [\--no-wait-for-sync] [\--submit] [\--print-job-id]
1614 | {*instance*} {*disk*} {*amount*}
1616 Grows an instance's disk. This is only possible for instances having a
1617 plain, drbd, file, sharedfile, rbd or ext disk template. For the ext
1618 template to work, the ExtStorage provider should also support growing.
1619 This means having a ``grow`` script that actually grows the volume of
1620 the external shared storage.
1622 Note that this command only change the block device size; it will not
1623 grow the actual filesystems, partitions, etc. that live on that
1624 disk. Usually, you will need to:
1626 #. use **gnt-instance grow-disk**
1628 #. reboot the instance (later, at a convenient time)
1630 #. use a filesystem resizer, such as **ext2online**\(8) or
1631 **xfs\_growfs**\(8) to resize the filesystem, or use **fdisk**\(8) to
1632 change the partition table on the disk
1634 The *disk* argument is the index of the instance disk to grow. The
1635 *amount* argument is given as a number which can have a suffix (like the
1636 disk size in instance create); if the suffix is missing, the value will
1637 be interpreted as mebibytes.
1639 By default, the *amount* value represents the desired increase in the
1640 disk size (e.g. an amount of 1G will take a disk of size 3G to 4G). If
1641 the optional ``--absolute`` parameter is passed, then the *amount*
1642 argument doesn't represent the delta, but instead the desired final disk
1643 size (e.g. an amount of 8G will take a disk of size 4G to 8G).
1645 For instances with a drbd template, note that the disk grow operation
1646 might complete on one node but fail on the other; this will leave the
1647 instance with different-sized LVs on the two nodes, but this will not
1648 create problems (except for unused space).
1650 If you do not want gnt-instance to wait for the new disk region to be
1651 synced, use the ``--no-wait-for-sync`` option.
1653 See **ganeti**\(7) for a description of ``--submit`` and other common
1656 Example (increase the first disk for instance1 by 16GiB)::
1658 # gnt-instance grow-disk instance1.example.com 0 16g
1660 Example for increasing the disk size to a certain size::
1662 # gnt-instance grow-disk --absolute instance1.example.com 0 32g
1664 Also note that disk shrinking is not supported; use **gnt-backup
1665 export** and then **gnt-backup import** to reduce the disk size of an
1671 | **recreate-disks** [\--submit] [\--print-job-id]
1672 | [{-n node1:[node2] \| {-I\|\--iallocator *name*}}]
1673 | [\--disk=*N*[:[size=*VAL*][,spindles=*VAL*][,mode=*ro\|rw*]]] {*instance*}
1675 Recreates all or a subset of disks of the given instance.
1677 Note that this functionality should only be used for missing disks; if
1678 any of the given disks already exists, the operation will fail. While
1679 this is suboptimal, recreate-disks should hopefully not be needed in
1680 normal operation and as such the impact of this is low.
1682 If only a subset should be recreated, any number of ``disk`` options can
1683 be specified. It expects a disk index and an optional list of disk
1684 parameters to change. Only ``size``, ``spindles``, and ``mode`` can be
1685 changed while recreating disks. To recreate all disks while changing
1686 parameters on a subset only, a ``--disk`` option must be given for every
1687 disk of the instance.
1689 Optionally the instance's disks can be recreated on different
1690 nodes. This can be useful if, for example, the original nodes of the
1691 instance have gone down (and are marked offline), so we can't recreate
1692 on the same nodes. To do this, pass the new node(s) via ``-n`` option,
1693 with a syntax similar to the **add** command. The number of nodes
1694 passed must equal the number of nodes that the instance currently
1695 has. Note that changing nodes is only allowed when all disks are
1696 replaced, e.g. when no ``--disk`` option is passed.
1698 Another method of choosing which nodes to place the instance on is by
1699 using the specified iallocator, passing the ``--iallocator`` option.
1700 The primary and secondary nodes will be chosen by the specified
1701 iallocator plugin, or by the default allocator if ``.`` is specified.
1703 See **ganeti**\(7) for a description of ``--submit`` and other common
1712 | **failover** [-f] [\--ignore-consistency] [\--ignore-ipolicy]
1713 | [\--shutdown-timeout=*N*]
1714 | [{-n|\--target-node} *node* \| {-I|\--iallocator} *name*]
1716 | [\--submit] [\--print-job-id]
1719 Failover will stop the instance (if running), change its primary node,
1720 and if it was originally running it will start it again (on the new
1721 primary). This works for instances with drbd template (in which case you
1722 can only fail to the secondary node) and for externally mirrored
1723 templates (sharedfile, blockdev, rbd and ext) (in which case you can
1724 fail to any other node).
1726 If the instance's disk template is of type sharedfile, blockdev, rbd or
1727 ext, then you can explicitly specify the target node (which can be any
1728 node) using the ``-n`` or ``--target-node`` option, or specify an
1729 iallocator plugin using the ``-I`` or ``--iallocator`` option. If you
1730 omit both, the default iallocator will be used to specify the target
1733 If the instance's disk template is of type drbd, the target node is
1734 automatically selected as the drbd's secondary node. Changing the
1735 secondary node is possible with a replace-disks operation.
1737 Normally the failover will check the consistency of the disks before
1738 failing over the instance. If you are trying to migrate instances off
1739 a dead node, this will fail. Use the ``--ignore-consistency`` option
1740 for this purpose. Note that this option can be dangerous as errors in
1741 shutting down the instance will be ignored, resulting in possibly
1742 having the instance running on two machines in parallel (on
1743 disconnected DRBD drives).
1745 The ``--shutdown-timeout`` is used to specify how much time to wait
1746 before forcing the shutdown (xm destroy in xen, killing the kvm
1747 process, for kvm). By default two minutes are given to each instance
1750 If ``--ignore-ipolicy`` is given any instance policy violations occuring
1751 during this operation are ignored.
1753 If the ``--cleanup`` option is passed, the operation changes from
1754 performin a failover to attempting recovery from a failed previous failover.
1755 In this mode, Ganeti checks if the instance runs on the correct node (and
1756 updates its configuration if not) and ensures the instances' disks
1757 are configured correctly.
1759 See **ganeti**\(7) for a description of ``--submit`` and other common
1764 # gnt-instance failover instance1.example.com
1766 For externally mirrored templates also ``-n`` is available::
1768 # gnt-instance failover -n node3.example.com instance1.example.com
1774 | **migrate** [-f] [\--allow-failover] [\--non-live]
1775 | [\--migration-mode=live\|non-live] [\--ignore-ipolicy]
1776 | [\--no-runtime-changes] [\--submit] [\--print-job-id]
1777 | [{-n|\--target-node} *node* \| {-I|\--iallocator} *name*] {*instance*}
1779 | **migrate** [-f] \--cleanup [\--submit] [\--print-job-id] {*instance*}
1781 Migrate will move the instance to its secondary node without shutdown.
1782 As with failover, it works for instances having the drbd disk template
1783 or an externally mirrored disk template type such as sharedfile,
1784 blockdev, rbd or ext.
1786 If the instance's disk template is of type sharedfile, blockdev, rbd or
1787 ext, then you can explicitly specify the target node (which can be any
1788 node) using the ``-n`` or ``--target-node`` option, or specify an
1789 iallocator plugin using the ``-I`` or ``--iallocator`` option. If you
1790 omit both, the default iallocator will be used to specify the target
1791 node. Alternatively, the default iallocator can be requested by
1792 specifying ``.`` as the name of the plugin.
1794 If the instance's disk template is of type drbd, the target node is
1795 automatically selected as the drbd's secondary node. Changing the
1796 secondary node is possible with a replace-disks operation.
1798 The migration command needs a perfectly healthy instance for drbd
1799 instances, as we rely on the dual-master capability of drbd8 and the
1800 disks of the instance are not allowed to be degraded.
1802 The ``--non-live`` and ``--migration-mode=non-live`` options will
1803 switch (for the hypervisors that support it) between a "fully live"
1804 (i.e. the interruption is as minimal as possible) migration and one in
1805 which the instance is frozen, its state saved and transported to the
1806 remote node, and then resumed there. This all depends on the
1807 hypervisor support for two different methods. In any case, it is not
1808 an error to pass this parameter (it will just be ignored if the
1809 hypervisor doesn't support it). The option ``--migration-mode=live``
1810 option will request a fully-live migration. The default, when neither
1811 option is passed, depends on the hypervisor parameters (and can be
1812 viewed with the **gnt-cluster info** command).
1814 If the ``--cleanup`` option is passed, the operation changes from
1815 migration to attempting recovery from a failed previous migration. In
1816 this mode, Ganeti checks if the instance runs on the correct node (and
1817 updates its configuration if not) and ensures the instances' disks
1818 are configured correctly. In this mode, the ``--non-live`` option is
1821 The option ``-f`` will skip the prompting for confirmation.
1823 If ``--allow-failover`` is specified it tries to fallback to failover if
1824 it already can determine that a migration won't work (e.g. if the
1825 instance is shut down). Please note that the fallback will not happen
1826 during execution. If a migration fails during execution it still fails.
1828 If ``--ignore-ipolicy`` is given any instance policy violations occuring
1829 during this operation are ignored.
1831 The ``--no-runtime-changes`` option forbids migrate to alter an
1832 instance's runtime before migrating it (eg. ballooning an instance
1833 down because the target node doesn't have enough available memory).
1835 If an instance has the backend parameter ``always_failover`` set to
1836 true, then the migration is automatically converted into a failover.
1838 See **ganeti**\(7) for a description of ``--submit`` and other common
1841 Example (and expected output)::
1843 # gnt-instance migrate instance1
1844 Instance instance1 will be migrated. Note that migration
1845 might impact the instance if anything goes wrong (e.g. due to bugs in
1846 the hypervisor). Continue?
1848 Migrating instance instance1.example.com
1849 * checking disk consistency between source and target
1850 * switching node node2.example.com to secondary mode
1851 * changing into standalone mode
1852 * changing disks into dual-master mode
1853 * wait until resync is done
1854 * preparing node2.example.com to accept the instance
1855 * migrating instance to node2.example.com
1856 * switching node node1.example.com to secondary mode
1857 * wait until resync is done
1858 * changing into standalone mode
1859 * changing disks into single-master mode
1860 * wait until resync is done
1868 | **move** [-f] [\--ignore-consistency]
1869 | [-n *node*] [\--shutdown-timeout=*N*] [\--submit] [\--print-job-id]
1870 | [\--ignore-ipolicy]
1873 Move will move the instance to an arbitrary node in the cluster. This
1874 works only for instances having a plain or file disk template.
1876 Note that since this operation is done via data copy, it will take a
1877 long time for big disks (similar to replace-disks for a drbd
1880 The ``--shutdown-timeout`` is used to specify how much time to wait
1881 before forcing the shutdown (e.g. ``xm destroy`` in XEN, killing the
1882 kvm process for KVM, etc.). By default two minutes are given to each
1885 The ``--ignore-consistency`` option will make Ganeti ignore any errors
1886 in trying to shutdown the instance on its node; useful if the
1887 hypervisor is broken and you want to recover the data.
1889 If ``--ignore-ipolicy`` is given any instance policy violations occuring
1890 during this operation are ignored.
1892 See **ganeti**\(7) for a description of ``--submit`` and other common
1897 # gnt-instance move -n node3.example.com instance1.example.com
1903 | **change-group** [\--submit] [\--print-job-id]
1904 | [\--iallocator *NAME*] [\--to *GROUP*...] {*instance*}
1906 This command moves an instance to another node group. The move is
1907 calculated by an iallocator, either given on the command line or as a
1910 If no specific destination groups are specified using ``--to``, all
1911 groups except the one containing the instance are considered.
1913 See **ganeti**\(7) for a description of ``--submit`` and other common
1918 # gnt-instance change-group -I hail --to rack2 inst1.example.com
1927 **add-tags** [\--from *file*] {*instancename*} {*tag*...}
1929 Add tags to the given instance. If any of the tags contains invalid
1930 characters, the entire operation will abort.
1932 If the ``--from`` option is given, the list of tags will be extended
1933 with the contents of that file (each line becomes a tag). In this
1934 case, there is not need to pass tags on the command line (if you do,
1935 both sources will be used). A file name of ``-`` will be interpreted
1941 **list-tags** {*instancename*}
1943 List the tags of the given instance.
1948 **remove-tags** [\--from *file*] {*instancename*} {*tag*...}
1950 Remove tags from the given instance. If any of the tags are not
1951 existing on the node, the entire operation will abort.
1953 If the ``--from`` option is given, the list of tags to be removed will
1954 be extended with the contents of that file (each line becomes a tag).
1955 In this case, there is not need to pass tags on the command line (if
1956 you do, tags from both sources will be removed). A file name of ``-``
1957 will be interpreted as stdin.
1959 .. vim: set textwidth=72 :