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*}[,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*}
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 The access mode. Either ``ro`` (read-only) or the default ``rw``
65 this option specifies a name for the disk, which can be used as a disk
66 identifier. An instance can not have two disks with the same name.
69 The LVM volume group. This works only for LVM and DRBD devices.
72 This options specifies a different VG for the metadata device. This
73 works only for DRBD devices
75 When creating ExtStorage disks, also arbitrary parameters can be passed,
76 to the ExtStorage provider. Those parameters are passed as additional
77 comma separated options. Therefore, an ExtStorage disk provided by
78 provider ``pvdr1`` with parameters ``param1``, ``param2`` would be
79 passed as ``--disk 0:size=10G,provider=pvdr1,param1=val1,param2=val2``.
81 When using the ``adopt`` key in the disk definition, Ganeti will
82 reuse those volumes (instead of creating new ones) as the
83 instance's disks. Ganeti will rename these volumes to the standard
84 format, and (without installing the OS) will use them as-is for the
85 instance. This allows migrating instances from non-managed mode
86 (e.g. plain KVM with LVM) to being managed via Ganeti. Please note that
87 this works only for the \`plain' disk template (see below for
90 Alternatively, a single-disk instance can be created via the ``-s``
91 option which takes a single argument, the size of the disk. This is
92 similar to the Ganeti 1.2 version (but will only create one disk).
94 The minimum disk specification is therefore ``--disk 0:size=20G`` (or
95 ``-s 20G`` when using the ``-s`` option), and a three-disk instance
96 can be specified as ``--disk 0:size=20G --disk 1:size=4G --disk
99 The minimum information needed to specify an ExtStorage disk are the
100 ``size`` and the ``provider``. For example:
101 ``--disk 0:size=20G,provider=pvdr1``.
103 The ``--no-ip-check`` skips the checks that are done to see if the
104 instance's IP is not already alive (i.e. reachable from the master
107 The ``--no-name-check`` skips the check for the instance name via
108 the resolver (e.g. in DNS or /etc/hosts, depending on your setup).
109 Since the name check is used to compute the IP address, if you pass
110 this option you must also pass the ``--no-ip-check`` option.
112 If you don't want the instance to automatically start after
113 creation, this is possible via the ``--no-start`` option. This will
114 leave the instance down until a subsequent **gnt-instance start**
117 The NICs of the instances can be specified via the ``--net``
118 option. By default, one NIC is created for the instance, with a
119 random MAC, and set up according the the cluster level NIC
120 parameters. Each NIC can take these parameters (all optional):
123 either a value or 'generate' to generate a new unique MAC
126 specifies the IP address assigned to the instance from the Ganeti
127 side (this is not necessarily what the instance will use, but what
128 the node expects the instance to use). Note that if an IP in the
129 range of a network configured with **gnt-network**\(8) is used,
130 and the NIC is not already connected to it, this network has to be
131 passed in the **network** parameter if this NIC is meant to be
132 connected to the said network. ``--no-conflicts-check`` can be used
133 to override this check. The special value **pool** causes Ganeti to
134 select an IP from the the network the NIC is or will be connected to.
137 specifies the connection mode for this NIC: routed, bridged or
141 in bridged or openvswitch mode specifies the interface to attach
142 this NIC to, in routed mode it's intended to differentiate between
143 different routing tables/instance groups (but the meaning is
144 dependent on the network script, see **gnt-cluster**\(8) for more
145 details). Note that openvswitch support is also hypervisor
149 derives the mode and the link from the settings of the network
150 which is identified by its name. If the network option is chosen,
151 link and mode must not be specified. Note that the mode and link
152 depend on the network-to-nodegroup connection, thus allowing
153 different nodegroups to be connected to the same network in
157 this option specifies a name for the NIC, which can be used as a NIC
158 identifier. An instance can not have two NICs with the same name.
161 Of these "mode" and "link" are NIC parameters, and inherit their
162 default at cluster level. Alternatively, if no network is desired for
163 the instance, you can prevent the default of one NIC with the
164 ``--no-nics`` option.
166 The ``-o (--os-type)`` option specifies the operating system to be
167 installed. The available operating systems can be listed with
168 **gnt-os list**. Passing ``--no-install`` will however skip the OS
169 installation, allowing a manual import if so desired. Note that the
170 no-installation mode will automatically disable the start-up of the
171 instance (without an OS, it most likely won't be able to start-up
174 The ``-B (--backend-parameters)`` option specifies the backend
175 parameters for the instance. If no such parameters are specified, the
176 values are inherited from the cluster. Possible parameters are:
179 the maximum memory size of the instance; as usual, suffixes can be
180 used to denote the unit, otherwise the value is taken in mebibytes
183 the minimum memory size of the instance; as usual, suffixes can be
184 used to denote the unit, otherwise the value is taken in mebibytes
187 the number of VCPUs to assign to the instance (if this value makes
188 sense for the hypervisor)
191 whether the instance is considered in the N+1 cluster checks
192 (enough redundancy in the cluster to survive a node failure)
195 ``True`` or ``False``, whether the instance must be failed over
196 (shut down and rebooted) always or it may be migrated (briefly
199 Note that before 2.6 Ganeti had a ``memory`` parameter, which was the
200 only value of memory an instance could have. With the
201 ``maxmem``/``minmem`` change Ganeti guarantees that at least the minimum
202 memory is always available for an instance, but allows more memory to be
203 used (up to the maximum memory) should it be free.
205 The ``-H (--hypervisor-parameters)`` option specified the hypervisor
206 to use for the instance (must be one of the enabled hypervisors on the
207 cluster) and optionally custom parameters for this instance. If not
208 other options are used (i.e. the invocation is just -H *NAME*) the
209 instance will inherit the cluster options. The defaults below show the
210 cluster defaults at cluster creation time.
212 The possible hypervisor options are as follows:
215 Valid for the Xen HVM and KVM hypervisors.
217 A string value denoting the boot order. This has different meaning
218 for the Xen HVM hypervisor and for the KVM one.
220 For Xen HVM, The boot order is a string of letters listing the boot
221 devices, with valid device letters being:
235 The default is not to set an HVM boot order, which is interpreted
238 For KVM the boot order is either "floppy", "cdrom", "disk" or
239 "network". Please note that older versions of KVM couldn't netboot
240 from virtio interfaces. This has been fixed in more recent versions
241 and is confirmed to work at least with qemu-kvm 0.11.1. Also note
242 that if you have set the ``kernel_path`` option, that will be used
243 for booting, and this setting will be silently ignored.
246 Valid for the Xen HVM and PVM hypervisors.
248 Relevant to non-pvops guest kernels, in which the disk device names
249 are given by the host. Allows one to specify 'xvd', which helps run
250 Red Hat based installers, driven by anaconda.
253 Valid for the KVM hypervisor.
255 The path to a floppy disk image to attach to the instance. This
256 is useful to install Windows operating systems on Virt/IO disks
257 because you can specify here the floppy for the drivers at
261 Valid for the Xen HVM and KVM hypervisors.
263 The path to a CDROM image to attach to the instance.
266 Valid for the KVM hypervisor.
268 The path to a second CDROM image to attach to the instance.
269 **NOTE**: This image can't be used to boot the system. To do that
270 you have to use the 'cdrom\_image\_path' option.
273 Valid for the Xen HVM and KVM hypervisors.
275 This parameter determines the way the network cards are presented
276 to the instance. The possible options are:
278 - rtl8139 (default for Xen HVM) (HVM & KVM)
279 - ne2k\_isa (HVM & KVM)
280 - ne2k\_pci (HVM & KVM)
286 - paravirtual (default for KVM) (HVM & KVM)
289 Valid for the Xen HVM hypervisor.
291 This parameter specifies the vif type of the nic configuration
292 of the instance. Unsetting the value leads to no type being specified
293 in the configuration. Note that this parameter only takes effect when
294 the 'nic_type' is not set. The possible options are:
300 Valid for the Xen HVM and KVM hypervisors.
302 This parameter determines the way the disks are presented to the
303 instance. The possible options are:
305 - ioemu [default] (HVM & KVM)
314 Valid for the KVM hypervisor.
316 This parameter determines the way the cdroms disks are presented
317 to the instance. The default behavior is to get the same value of
318 the earlier parameter (disk_type). The possible options are:
329 Valid for the Xen HVM and KVM hypervisors.
331 Specifies the address that the VNC listener for this instance
332 should bind to. Valid values are IPv4 addresses. Use the address
333 0.0.0.0 to bind to all available interfaces (this is the default)
334 or specify the address of one of the interfaces on the node to
335 restrict listening to that interface.
338 Valid for the KVM hypervisor.
340 A boolean option that controls whether the VNC connection is
344 Valid for the KVM hypervisor.
346 If ``vnc_tls`` is enabled, this options specifies the path to the
347 x509 certificate to use.
350 Valid for the KVM hypervisor.
353 Valid for the KVM hypervisor.
355 Specifies the address or interface on which the SPICE server will
356 listen. Valid values are:
358 - IPv4 addresses, including 0.0.0.0 and 127.0.0.1
359 - IPv6 addresses, including :: and ::1
360 - names of network interfaces
362 If a network interface is specified, the SPICE server will be bound
363 to one of the addresses of that interface.
366 Valid for the KVM hypervisor.
368 Specifies which version of the IP protocol should be used by the
371 It is mainly intended to be used for specifying what kind of IP
372 addresses should be used if a network interface with both IPv4 and
373 IPv6 addresses is specified via the ``spice_bind`` parameter. In
374 this case, if the ``spice_ip_version`` parameter is not used, the
375 default IP version of the cluster will be used.
377 spice\_password\_file
378 Valid for the KVM hypervisor.
380 Specifies a file containing the password that must be used when
381 connecting via the SPICE protocol. If the option is not specified,
382 passwordless connections are allowed.
384 spice\_image\_compression
385 Valid for the KVM hypervisor.
387 Configures the SPICE lossless image compression. Valid values are:
396 spice\_jpeg\_wan\_compression
397 Valid for the KVM hypervisor.
399 Configures how SPICE should use the jpeg algorithm for lossy image
400 compression on slow links. Valid values are:
406 spice\_zlib\_glz\_wan\_compression
407 Valid for the KVM hypervisor.
409 Configures how SPICE should use the zlib-glz algorithm for lossy image
410 compression on slow links. Valid values are:
416 spice\_streaming\_video
417 Valid for the KVM hypervisor.
419 Configures how SPICE should detect video streams. Valid values are:
425 spice\_playback\_compression
426 Valid for the KVM hypervisor.
428 Configures whether SPICE should compress audio streams or not.
431 Valid for the KVM hypervisor.
433 Specifies that the SPICE server must use TLS to encrypt all the
434 traffic with the client.
437 Valid for the KVM hypervisor.
439 Specifies a list of comma-separated ciphers that SPICE should use
440 for TLS connections. For the format, see man **cipher**\(1).
443 Valid for the KVM hypervisor.
445 Enables or disables passing mouse events via SPICE vdagent.
448 Valid for the KVM hypervisor.
450 This parameter determines the emulated cpu for the instance. If this
451 parameter is empty (which is the default configuration), it will not
454 Be aware of setting this parameter to ``"host"`` if you have nodes
455 with different CPUs from each other. Live migration may stop working
458 For more information please refer to the KVM manual.
461 Valid for the Xen HVM and KVM hypervisors.
463 A boolean option that specifies if the hypervisor should enable
464 ACPI support for this instance. By default, ACPI is disabled.
467 Valid for the Xen HVM and KVM hypervisors.
469 A boolean option that specifies if the hypervisor should enable
470 PAE support for this instance. The default is false, disabling PAE
474 Valid for the Xen HVM hypervisor.
476 A boolean option that specifies if the hypervisor should enable
477 viridian (Hyper-V) for this instance. The default is false,
478 disabling viridian support.
481 Valid for the Xen HVM and KVM hypervisors.
483 A boolean option that specifies if the instance should be started
484 with its clock set to the localtime of the machine (when true) or
485 to the UTC (When false). The default is false, which is useful for
486 Linux/Unix machines; for Windows OSes, it is recommended to enable
490 Valid for the Xen PVM and KVM hypervisors.
492 This option specifies the path (on the node) to the kernel to boot
493 the instance with. Xen PVM instances always require this, while for
494 KVM if this option is empty, it will cause the machine to load the
495 kernel from its disks (and the boot will be done accordingly to
499 Valid for the Xen PVM and KVM hypervisors.
501 This options specifies extra arguments to the kernel that will be
502 loaded. device. This is always used for Xen PVM, while for KVM it
503 is only used if the ``kernel_path`` option is also specified.
505 The default setting for this value is simply ``"ro"``, which
506 mounts the root disk (initially) in read-only one. For example,
507 setting this to single will cause the instance to start in
511 Valid for the Xen PVM and KVM hypervisors.
513 This option specifies the path (on the node) to the initrd to boot
514 the instance with. Xen PVM instances can use this always, while
515 for KVM if this option is only used if the ``kernel_path`` option
516 is also specified. You can pass here either an absolute filename
517 (the path to the initrd) if you want to use an initrd, or use the
518 format no\_initrd\_path for no initrd.
521 Valid for the Xen PVM and KVM hypervisors.
523 This options specifies the name of the root device. This is always
524 needed for Xen PVM, while for KVM it is only used if the
525 ``kernel_path`` option is also specified.
527 Please note, that if this setting is an empty string and the
528 hypervisor is Xen it will not be written to the Xen configuration
532 Valid for the KVM hypervisor.
534 This boolean option specifies whether to emulate a serial console
535 for the instance. Note that some versions of KVM have a bug that
536 will make an instance hang when configured to use the serial console
537 unless a connection is made to it within about 2 seconds of the
538 instance's startup. For such case it's recommended to disable this
539 option, which is enabled by default.
542 Valid for the KVM hypervisor.
544 This integer option specifies the speed of the serial console.
545 Common values are 9600, 19200, 38400, 57600 and 115200: choose the
546 one which works on your system. (The default is 38400 for historical
547 reasons, but newer versions of kvm/qemu work with 115200)
550 Valid for the KVM hypervisor.
552 The disk cache mode. It can be either default to not pass any
553 cache option to KVM, or one of the KVM cache modes: none (for
554 direct I/O), writethrough (to use the host cache but report
555 completion to the guest only when the host has committed the
556 changes to disk) or writeback (to use the host cache and report
557 completion as soon as the data is in the host cache). Note that
558 there are special considerations for the cache mode depending on
559 version of KVM used and disk type (always raw file under Ganeti),
560 please refer to the KVM documentation for more details.
563 Valid for the KVM hypervisor.
565 The security model for kvm. Currently one of *none*, *user* or
566 *pool*. Under *none*, the default, nothing is done and instances
567 are run as the Ganeti daemon user (normally root).
569 Under *user* kvm will drop privileges and become the user
570 specified by the security\_domain parameter.
572 Under *pool* a global cluster pool of users will be used, making
573 sure no two instances share the same user on the same node. (this
574 mode is not implemented yet)
577 Valid for the KVM hypervisor.
579 Under security model *user* the username to run the instance
580 under. It must be a valid username existing on the host.
582 Cannot be set under security model *none* or *pool*.
585 Valid for the KVM hypervisor.
587 If *enabled* the -enable-kvm flag is passed to kvm. If *disabled*
588 -disable-kvm is passed. If unset no flag is passed, and the
589 default running mode for your kvm binary will be used.
592 Valid for the KVM hypervisor.
594 This option passes the -mem-path argument to kvm with the path (on
595 the node) to the mount point of the hugetlbfs file system, along
596 with the -mem-prealloc argument too.
599 Valid for the KVM hypervisor.
601 This boolean option determines whether to run the KVM instance in a
604 If it is set to ``true``, an empty directory is created before
605 starting the instance and its path is passed via the -chroot flag
606 to kvm. The directory is removed when the instance is stopped.
608 It is set to ``false`` by default.
611 Valid for the KVM hypervisor.
613 The maximum amount of time (in ms) a KVM instance is allowed to be
614 frozen during a live migration, in order to copy dirty memory
615 pages. Default value is 30ms, but you may need to increase this
616 value for busy instances.
618 This option is only effective with kvm versions >= 87 and qemu-kvm
622 Valid for the Xen, KVM and LXC hypervisors.
624 The processes belonging to the given instance are only scheduled
625 on the specified CPUs.
627 The format of the mask can be given in three forms. First, the word
628 "all", which signifies the common case where all VCPUs can live on
629 any CPU, based on the hypervisor's decisions.
631 Second, a comma-separated list of CPU IDs or CPU ID ranges. The
632 ranges are defined by a lower and higher boundary, separated by a
633 dash, and the boundaries are inclusive. In this form, all VCPUs of
634 the instance will be mapped on the selected list of CPUs. Example:
635 ``0-2,5``, mapping all VCPUs (no matter how many) onto physical CPUs
638 The last form is used for explicit control of VCPU-CPU pinnings. In
639 this form, the list of VCPU mappings is given as a colon (:)
640 separated list, whose elements are the possible values for the
641 second or first form above. In this form, the number of elements in
642 the colon-separated list _must_ equal the number of VCPUs of the
649 # Map the entire instance to CPUs 0-2
650 gnt-instance modify -H cpu_mask=0-2 my-inst
652 # Map vCPU 0 to physical CPU 1 and vCPU 1 to CPU 3 (assuming 2 vCPUs)
653 gnt-instance modify -H cpu_mask=1:3 my-inst
655 # Pin vCPU 0 to CPUs 1 or 2, and vCPU 1 to any CPU
656 gnt-instance modify -H cpu_mask=1-2:all my-inst
658 # Pin vCPU 0 to any CPU, vCPU 1 to CPUs 1, 3, 4 or 5, and CPU 2 to
659 # CPU 0 (backslashes for escaping the comma)
660 gnt-instance modify -H cpu_mask=all:1\\,3-5:0 my-inst
662 # Pin entire VM to CPU 0
663 gnt-instance modify -H cpu_mask=0 my-inst
665 # Turn off CPU pinning (default setting)
666 gnt-instance modify -H cpu_mask=all my-inst
669 Valid for the Xen hypervisor.
671 Set the maximum amount of cpu usage by the VM. The value is a percentage
672 between 0 and (100 * number of VCPUs). Default cap is 0: unlimited.
675 Valid for the Xen hypervisor.
677 Set the cpu time ratio to be allocated to the VM. Valid values are
678 between 1 and 65535. Default weight is 256.
681 Valid for the KVM hypervisor.
683 This option specifies the usb mouse type to be used. It can be
684 "mouse" or "tablet". When using VNC it's recommended to set it to
688 Valid for the KVM hypervisor.
690 This option specifies the keyboard mapping to be used. It is only
691 needed when using the VNC console. For example: "fr" or "en-gb".
694 Valid for Xen PVM, Xen HVM and KVM hypervisors.
696 Normally if an instance reboots, the hypervisor will restart it. If
697 this option is set to ``exit``, the hypervisor will treat a reboot
698 as a shutdown instead.
700 It is set to ``reboot`` by default.
703 Valid for the KVM hypervisor.
705 Number of emulated CPU cores.
708 Valid for the KVM hypervisor.
710 Number of emulated CPU threads.
713 Valid for the KVM hypervisor.
715 Number of emulated CPU sockets.
718 Valid for the KVM hypervisor.
720 Comma separated list of emulated sounds cards, or "all" to enable
721 all the available ones.
724 Valid for the KVM hypervisor.
726 Space separated list of usb devices. These can be emulated devices
727 or passthrough ones, and each one gets passed to kvm with its own
728 ``-usbdevice`` option. See the **qemu**\(1) manpage for the syntax
729 of the possible components. Note that values set with this
730 parameter are split on a space character and currently don't support
734 Valid for the KVM hypervisor.
736 Emulated vga mode, passed the the kvm -vga option.
739 Valid for the KVM hypervisor.
741 Any other option to the KVM hypervisor, useful tweaking anything
742 that Ganeti doesn't support. Note that values set with this
743 parameter are split on a space character and currently don't support
747 Valid for the KVM hypervisor.
749 Use in case an instance must be booted with an exact type of
750 machine version (due to e.g. outdated drivers). In case it's not set
751 the default version supported by your version of kvm is used.
754 Valid for the KVM hypervisor.
756 Path to the userspace KVM (or qemu) program.
759 Valid for the KVM hypervisor.
761 This boolean option determines whether the tap devices used by the
762 KVM paravirtual nics (virtio-net) will get created with VNET_HDR
763 (IFF_VNET_HDR) support.
765 If set to false, it effectively disables offloading on the virio-net
766 interfaces, which prevents host kernel tainting and log flooding,
767 when dealing with broken or malicious virtio-net drivers.
769 It is set to ``true`` by default.
771 The ``-O (--os-parameters)`` option allows customisation of the OS
772 parameters. The actual parameter names and values depends on the OS
773 being used, but the syntax is the same key=value. For example, setting
774 a hypothetical ``dhcp`` parameter to yes can be achieved by::
776 gnt-instance add -O dhcp=yes ...
778 The ``-I (--iallocator)`` option specifies the instance allocator plugin
779 to use (``.`` means the default allocator). If you pass in this option
780 the allocator will select nodes for this instance automatically, so you
781 don't need to pass them with the ``-n`` option. For more information
782 please refer to the instance allocator documentation.
784 The ``-t (--disk-template)`` options specifies the disk layout type
785 for the instance. The available choices are:
788 This creates an instance with no disks. Its useful for testing only
789 (or other special cases).
792 Disk devices will be regular files.
795 Disk devices will be regulare files on a shared directory.
798 Disk devices will be logical volumes.
801 Disk devices will be drbd (version 8.x) on top of lvm volumes.
804 Disk devices will be rbd volumes residing inside a RADOS cluster.
807 Disk devices will be adopted pre-existent block devices.
810 Disk devices will be provided by external shared storage,
811 through the ExtStorage Interface using ExtStorage providers.
813 The optional second value of the ``-n (--node)`` is used for the drbd
814 template type and specifies the remote node.
816 If you do not want gnt-instance to wait for the disk mirror to be
817 synced, use the ``--no-wait-for-sync`` option.
819 The ``--file-storage-dir`` specifies the relative path under the
820 cluster-wide file storage directory to store file-based disks. It is
821 useful for having different subdirectories for different
822 instances. The full path of the directory where the disk files are
823 stored will consist of cluster-wide file storage directory + optional
824 subdirectory + instance name. Example:
825 ``@RPL_FILE_STORAGE_DIR@/mysubdir/instance1.example.com``. This
826 option is only relevant for instances using the file storage backend.
828 The ``--file-driver`` specifies the driver to use for file-based
829 disks. Note that currently these drivers work with the xen hypervisor
830 only. This option is only relevant for instances using the file
831 storage backend. The available choices are:
834 Kernel loopback driver. This driver uses loopback devices to
835 access the filesystem within the file. However, running I/O
836 intensive applications in your instance using the loop driver
837 might result in slowdowns. Furthermore, if you use the loopback
838 driver consider increasing the maximum amount of loopback devices
839 (on most systems it's 8) using the max\_loop param.
842 The blktap driver (for Xen hypervisors). In order to be able to
843 use the blktap driver you should check if the 'blktapctrl' user
844 space disk agent is running (usually automatically started via
845 xend). This user-level disk I/O interface has the advantage of
846 better performance. Especially if you use a network file system
847 (e.g. NFS) to store your instances this is the recommended choice.
850 Analogous to the blktap driver, but used by newer versions of Xen.
852 If ``--ignore-ipolicy`` is given any instance policy violations occuring
853 during this operation are ignored.
855 See **ganeti**\(7) for a description of ``--submit`` and other common
860 # gnt-instance add -t file --disk 0:size=30g -B maxmem=512 -o debian-etch \
861 -n node1.example.com --file-storage-dir=mysubdir instance1.example.com
862 # gnt-instance add -t plain --disk 0:size=30g -B maxmem=1024,minmem=512 \
863 -o debian-etch -n node1.example.com instance1.example.com
864 # gnt-instance add -t plain --disk 0:size=30g --disk 1:size=100g,vg=san \
865 -B maxmem=512 -o debian-etch -n node1.example.com instance1.example.com
866 # gnt-instance add -t drbd --disk 0:size=30g -B maxmem=512 -o debian-etch \
867 -n node1.example.com:node2.example.com instance2.example.com
868 # gnt-instance add -t rbd --disk 0:size=30g -B maxmem=512 -o debian-etch \
869 -n node1.example.com instance1.example.com
870 # gnt-instance add -t ext --disk 0:size=30g,provider=pvdr1 -B maxmem=512 \
871 -o debian-etch -n node1.example.com instance1.example.com
872 # gnt-instance add -t ext --disk 0:size=30g,provider=pvdr1,param1=val1 \
873 --disk 1:size=40g,provider=pvdr2,param2=val2,param3=val3 -B maxmem=512 \
874 -o debian-etch -n node1.example.com instance1.example.com
881 | [{-I|\--iallocator} *instance allocator*]
882 | {instances\_file.json}
884 This command (similar to the Ganeti 1.2 **batcher** tool) submits
885 multiple instance creation jobs based on a definition file. This
886 file can contain all options which are valid when adding an instance
887 with the exception of the ``iallocator`` field. The IAllocator is,
888 for optimization purposes, only allowed to be set for the whole batch
889 operation using the ``--iallocator`` parameter.
891 The instance file must be a valid-formed JSON file, containing an
892 array of dictionaries with instance creation parameters. All parameters
893 (except ``iallocator``) which are valid for the instance creation
894 OP code are allowed. The most important ones are:
897 The FQDN of the new instance.
900 The disk template to use for the instance, the same as in the
904 Array of disk specifications. Each entry describes one disk as a
905 dictionary of disk parameters.
908 A dictionary of backend parameters.
911 The hypervisor for the instance.
914 A dictionary with the hypervisor options. If not passed, the default
915 hypervisor options will be inherited.
918 List of NICs that will be created for the instance. Each entry
919 should be a dict, with mac, ip, mode and link as possible keys.
920 Please don't provide the "mac, ip, mode, link" parent keys if you
921 use this method for specifying NICs.
924 The primary and optionally the secondary node to use for the
925 instance (in case an iallocator script is not used). If those
926 parameters are given, they have to be given consistently for all
927 instances in the batch operation.
930 whether to start the instance
933 Skip the check for already-in-use instance; see the description in
934 the **add** command for details.
937 Skip the name check for instances; see the description in the
938 **add** command for details.
940 file\_storage\_dir, file\_driver
941 Configuration for the file disk type, see the **add** command for
945 A simple definition for one instance can be (with most of the
946 parameters taken from the cluster defaults)::
951 "instance_name": "instance1.example.com",
952 "disk_template": "drbd",
953 "os_type": "debootstrap",
954 "disks": [{"size":"1024"}],
956 "hypervisor": "xen-pvm"
960 "instance_name": "instance2.example.com",
961 "disk_template": "drbd",
962 "os_type": "debootstrap",
963 "disks": [{"size":"4096", "mode": "rw", "vg": "xenvg"}],
965 "hypervisor": "xen-hvm",
966 "hvparams": {"acpi": true},
967 "beparams": {"maxmem": 512, "minmem": 256}
971 The command will display the job id for each submitted instance, as
974 # gnt-instance batch-create instances.json
975 Submitted jobs 37, 38
980 **remove** [\--ignore-failures] [\--shutdown-timeout=*N*] [\--submit]
981 [\--force] {*instance*}
983 Remove an instance. This will remove all data from the instance and
984 there is *no way back*. If you are not sure if you use an instance
985 again, use **shutdown** first and leave it in the shutdown state for a
988 The ``--ignore-failures`` option will cause the removal to proceed
989 even in the presence of errors during the removal of the instance
990 (e.g. during the shutdown or the disk removal). If this option is not
991 given, the command will stop at the first error.
993 The ``--shutdown-timeout`` is used to specify how much time to wait
994 before forcing the shutdown (e.g. ``xm destroy`` in Xen, killing the
995 kvm process for KVM, etc.). By default two minutes are given to each
998 The ``--force`` option is used to skip the interactive confirmation.
1000 See **ganeti**\(7) for a description of ``--submit`` and other common
1005 # gnt-instance remove instance1.example.com
1012 | [\--no-headers] [\--separator=*SEPARATOR*] [\--units=*UNITS*] [-v]
1013 | [{-o|\--output} *[+]FIELD,...*] [\--filter] [instance...]
1015 Shows the currently configured instances with memory usage, disk
1016 usage, the node they are running on, and their run status.
1018 The ``--no-headers`` option will skip the initial header line. The
1019 ``--separator`` option takes an argument which denotes what will be
1020 used between the output fields. Both these options are to help
1023 The units used to display the numeric values in the output varies,
1024 depending on the options given. By default, the values will be
1025 formatted in the most appropriate unit. If the ``--separator`` option
1026 is given, then the values are shown in mebibytes to allow parsing by
1027 scripts. In both cases, the ``--units`` option can be used to enforce
1028 a given output unit.
1030 The ``-v`` option activates verbose mode, which changes the display of
1031 special field states (see **ganeti**\(7)).
1033 The ``-o (--output)`` option takes a comma-separated list of output
1034 fields. The available fields and their meaning are:
1036 @QUERY_FIELDS_INSTANCE@
1038 If the value of the option starts with the character ``+``, the new
1039 field(s) will be added to the default list. This allows one to quickly
1040 see the default list plus a few other fields, instead of retyping the
1041 entire list of fields.
1043 There is a subtle grouping about the available output fields: all
1044 fields except for ``oper_state``, ``oper_ram``, ``oper_vcpus`` and
1045 ``status`` are configuration value and not run-time values. So if you
1046 don't select any of the these fields, the query will be satisfied
1047 instantly from the cluster configuration, without having to ask the
1048 remote nodes for the data. This can be helpful for big clusters when
1049 you only want some data and it makes sense to specify a reduced set of
1052 If exactly one argument is given and it appears to be a query filter
1053 (see **ganeti**\(7)), the query result is filtered accordingly. For
1054 ambiguous cases (e.g. a single field name as a filter) the ``--filter``
1055 (``-F``) option forces the argument to be treated as a filter (e.g.
1056 ``gnt-instance list -F admin_state``).
1058 The default output field list is: ``name``, ``os``, ``pnode``,
1059 ``admin_state``, ``oper_state``, ``oper_ram``.
1065 **list-fields** [field...]
1067 Lists available fields for instances.
1073 **info** [-s \| \--static] [\--roman] {\--all \| *instance*}
1075 Show detailed information about the given instance(s). This is
1076 different from **list** as it shows detailed data about the instance's
1077 disks (especially useful for the drbd disk template).
1079 If the option ``-s`` is used, only information available in the
1080 configuration file is returned, without querying nodes, making the
1083 Use the ``--all`` to get info about all instances, rather than
1084 explicitly passing the ones you're interested in.
1086 The ``--roman`` option can be used to cause envy among people who like
1087 ancient cultures, but are stuck with non-latin-friendly cluster
1088 virtualization technologies.
1094 | [{-H|\--hypervisor-parameters} *HYPERVISOR\_PARAMETERS*]
1095 | [{-B|\--backend-parameters} *BACKEND\_PARAMETERS*]
1096 | [{-m|\--runtime-memory} *SIZE*]
1097 | [\--net add[:options...] \|
1098 | \--net [*N*:]add[,options...] \|
1099 | \--net [*ID*:]remove \|
1100 | \--net *ID*:modify[,options...]]
1101 | [\--disk add:size=*SIZE*[,options...] \|
1102 | \--disk *N*:add,size=*SIZE*[,options...] \|
1103 | \--disk *N*:add,size=*SIZE*,provider=*PROVIDER*[,options...][,param=*value*... ] \|
1104 | \--disk *ID*:modify[,options...]
1105 | \--disk [*ID*:]remove]
1106 | [{-t|\--disk-template} plain | {-t|\--disk-template} drbd -n *new_secondary*] [\--no-wait-for-sync]
1107 | [\--new-primary=*node*]
1108 | [\--os-type=*OS* [\--force-variant]]
1109 | [{-O|\--os-parameters} *param*=*value*... ]
1110 | [\--offline \| \--online]
1112 | [\--ignore-ipolicy]
1115 Modifies the memory size, number of vcpus, ip address, MAC address
1116 and/or NIC parameters for an instance. It can also add and remove
1117 disks and NICs to/from the instance. Note that you need to give at
1118 least one of the arguments, otherwise the command complains.
1120 The ``-H (--hypervisor-parameters)``, ``-B (--backend-parameters)``
1121 and ``-O (--os-parameters)`` options specifies hypervisor, backend and
1122 OS parameter options in the form of name=value[,...]. For details
1123 which options can be specified, see the **add** command.
1125 The ``-t (--disk-template)`` option will change the disk template of
1126 the instance. Currently only conversions between the plain and drbd
1127 disk templates are supported, and the instance must be stopped before
1128 attempting the conversion. When changing from the plain to the drbd
1129 disk template, a new secondary node must be specified via the ``-n``
1130 option. The option ``--no-wait-for-sync`` can be used when converting
1131 to the ``drbd`` template in order to make the instance available for
1132 startup before DRBD has finished resyncing.
1134 The ``-m (--runtime-memory)`` option will change an instance's runtime
1135 memory to the given size (in MB if a different suffix is not specified),
1136 by ballooning it up or down to the new value.
1138 The ``--disk add:size=*SIZE*,[options..]`` option adds a disk to the
1139 instance, and ``--disk *N*:add:size=*SIZE*,[options..]`` will add a disk
1140 to the the instance at a specific index. The available options are the
1141 same as in the **add** command(``mode``, ``name``, ``vg``, ``metavg``).
1142 When adding an ExtStorage disk the ``provider=*PROVIDER*`` option is
1143 also mandatory and specifies the ExtStorage provider. Also, for
1144 ExtStorage disks arbitrary parameters can be passed as additional comma
1145 separated options, same as in the **add** command. -The ``--disk remove``
1146 option will remove the last disk of the instance. Use
1147 ``--disk `` *ID*``:remove`` to remove a disk by its identifier. *ID*
1148 can be the index of the disk, the disks's name or the disks's UUID. The
1149 ``--disk *ID*:modify[,options...]`` wil change the options of the disk.
1150 Available options are:
1153 The access mode. Either ``ro`` (read-only) or the default ``rw`` (read-write).
1156 this option specifies a name for the disk, which can be used as a disk
1157 identifier. An instance can not have two disks with the same name.
1159 The ``--net *N*:add[,options..]`` will add a new network interface to
1160 the instance. The available options are the same as in the **add**
1161 command (``mac``, ``ip``, ``link``, ``mode``, ``network``). The
1162 ``--net *ID*,remove`` will remove the intances' NIC with *ID* identifier,
1163 which can be the index of the NIC, the NIC's name or the NIC's UUID.
1164 The ``--net *ID*:modify[,options..]`` option will change the parameters of
1165 the instance network interface with the *ID* identifier.
1167 The option ``-o (--os-type)`` will change the OS name for the instance
1168 (without reinstallation). In case an OS variant is specified that is
1169 not found, then by default the modification is refused, unless
1170 ``--force-variant`` is passed. An invalid OS will also be refused,
1171 unless the ``--force`` option is given.
1173 The option ``--new-primary`` will set the new primary node of an instance
1174 assuming the disks have already been moved manually. Unless the ``--force``
1175 option is given, it is verified that the instance is no longer running
1176 on its current primary node.
1178 The ``--online`` and ``--offline`` options are used to transition an
1179 instance into and out of the ``offline`` state. An instance can be
1180 turned offline only if it was previously down. The ``--online`` option
1181 fails if the instance was not in the ``offline`` state, otherwise it
1182 changes instance's state to ``down``. These modifications take effect
1185 If ``--ignore-ipolicy`` is given any instance policy violations occuring
1186 during this operation are ignored.
1188 See **ganeti**\(7) for a description of ``--submit`` and other common
1191 Most of the changes take effect at the next restart. If the instance is
1192 running, there is no effect on the instance.
1197 | **reinstall** [{-o|\--os-type} *os-type*] [\--select-os] [-f *force*]
1198 | [\--force-multiple]
1199 | [\--instance \| \--node \| \--primary \| \--secondary \| \--all]
1200 | [{-O|\--os-parameters} *OS\_PARAMETERS*] [\--submit] {*instance*...}
1202 Reinstalls the operating system on the given instance(s). The
1203 instance(s) must be stopped when running this command. If the ``-o
1204 (--os-type)`` is specified, the operating system is changed.
1206 The ``--select-os`` option switches to an interactive OS reinstall.
1207 The user is prompted to select the OS template from the list of
1208 available OS templates. OS parameters can be overridden using ``-O
1209 (--os-parameters)`` (more documentation for this option under the
1212 Since this is a potentially dangerous command, the user will be
1213 required to confirm this action, unless the ``-f`` flag is passed.
1214 When multiple instances are selected (either by passing multiple
1215 arguments or by using the ``--node``, ``--primary``, ``--secondary``
1216 or ``--all`` options), the user must pass the ``--force-multiple``
1217 options to skip the interactive confirmation.
1219 See **ganeti**\(7) for a description of ``--submit`` and other common
1225 | **rename** [\--no-ip-check] [\--no-name-check] [\--submit]
1226 | {*instance*} {*new\_name*}
1228 Renames the given instance. The instance must be stopped when running
1229 this command. The requirements for the new name are the same as for
1230 adding an instance: the new name must be resolvable and the IP it
1231 resolves to must not be reachable (in order to prevent duplicate IPs
1232 the next time the instance is started). The IP test can be skipped if
1233 the ``--no-ip-check`` option is passed.
1235 Note that you can rename an instance to its same name, to force
1236 re-executing the os-specific rename script for that instance, if
1239 The ``--no-name-check`` skips the check for the new instance name via
1240 the resolver (e.g. in DNS or /etc/hosts, depending on your setup) and
1241 that the resolved name matches the provided name. Since the name check
1242 is used to compute the IP address, if you pass this option you must also
1243 pass the ``--no-ip-check`` option.
1245 See **ganeti**\(7) for a description of ``--submit`` and other common
1248 Starting/stopping/connecting to console
1249 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1255 | [\--force] [\--ignore-offline]
1256 | [\--force-multiple] [\--no-remember]
1257 | [\--instance \| \--node \| \--primary \| \--secondary \| \--all \|
1258 | \--tags \| \--node-tags \| \--pri-node-tags \| \--sec-node-tags]
1259 | [{-H|\--hypervisor-parameters} ``key=value...``]
1260 | [{-B|\--backend-parameters} ``key=value...``]
1261 | [\--submit] [\--paused]
1264 Starts one or more instances, depending on the following options. The
1265 four available modes are:
1268 will start the instances given as arguments (at least one argument
1269 required); this is the default selection
1272 will start the instances who have the given node as either primary
1276 will start all instances whose primary node is in the list of nodes
1277 passed as arguments (at least one node required)
1280 will start all instances whose secondary node is in the list of
1281 nodes passed as arguments (at least one node required)
1284 will start all instances in the cluster (no arguments accepted)
1287 will start all instances in the cluster with the tags given as
1291 will start all instances in the cluster on nodes with the tags
1295 will start all instances in the cluster on primary nodes with the
1296 tags given as arguments
1299 will start all instances in the cluster on secondary nodes with the
1300 tags given as arguments
1302 Note that although you can pass more than one selection option, the
1303 last one wins, so in order to guarantee the desired result, don't pass
1304 more than one such option.
1306 Use ``--force`` to start even if secondary disks are failing.
1307 ``--ignore-offline`` can be used to ignore offline primary nodes and
1308 mark the instance as started even if the primary is not available.
1310 The ``--force-multiple`` will skip the interactive confirmation in the
1311 case the more than one instance will be affected.
1313 The ``--no-remember`` option will perform the startup but not change
1314 the state of the instance in the configuration file (if it was stopped
1315 before, Ganeti will still think it needs to be stopped). This can be
1316 used for testing, or for a one shot-start where you don't want the
1317 watcher to restart the instance if it crashes.
1319 The ``-H (--hypervisor-parameters)`` and ``-B (--backend-parameters)``
1320 options specify temporary hypervisor and backend parameters that can
1321 be used to start an instance with modified parameters. They can be
1322 useful for quick testing without having to modify an instance back and
1325 # gnt-instance start -H kernel_args="single" instance1
1326 # gnt-instance start -B maxmem=2048 instance2
1329 The first form will start the instance instance1 in single-user mode,
1330 and the instance instance2 with 2GB of RAM (this time only, unless
1331 that is the actual instance memory size already). Note that the values
1332 override the instance parameters (and not extend them): an instance
1333 with "kernel\_args=ro" when started with -H kernel\_args=single will
1334 result in "single", not "ro single".
1336 The ``--paused`` option is only valid for Xen and kvm hypervisors. This
1337 pauses the instance at the start of bootup, awaiting ``gnt-instance
1338 console`` to unpause it, allowing the entire boot process to be
1339 monitored for debugging.
1341 See **ganeti**\(7) for a description of ``--submit`` and other common
1346 # gnt-instance start instance1.example.com
1347 # gnt-instance start --node node1.example.com node2.example.com
1348 # gnt-instance start --all
1356 | [\--force] [\--force-multiple] [\--ignore-offline] [\--no-remember]
1357 | [\--instance \| \--node \| \--primary \| \--secondary \| \--all \|
1358 | \--tags \| \--node-tags \| \--pri-node-tags \| \--sec-node-tags]
1362 Stops one or more instances. If the instance cannot be cleanly stopped
1363 during a hardcoded interval (currently 2 minutes), it will forcibly
1364 stop the instance (equivalent to switching off the power on a physical
1367 The ``--timeout`` is used to specify how much time to wait before
1368 forcing the shutdown (e.g. ``xm destroy`` in Xen, killing the kvm
1369 process for KVM, etc.). By default two minutes are given to each
1372 The ``--instance``, ``--node``, ``--primary``, ``--secondary``,
1373 ``--all``, ``--tags``, ``--node-tags``, ``--pri-node-tags`` and
1374 ``--sec-node-tags`` options are similar as for the **startup** command
1375 and they influence the actual instances being shutdown.
1377 ``--ignore-offline`` can be used to ignore offline primary nodes and
1378 force the instance to be marked as stopped. This option should be used
1379 with care as it can lead to an inconsistent cluster state.
1381 Use ``--force`` to be able to shutdown an instance even when it's marked
1382 as offline. This is useful is an offline instance ends up in the
1383 ``ERROR_up`` state, for example.
1385 The ``--no-remember`` option will perform the shutdown but not change
1386 the state of the instance in the configuration file (if it was running
1387 before, Ganeti will still thinks it needs to be running). This can be
1388 useful for a cluster-wide shutdown, where some instances are marked as
1389 up and some as down, and you don't want to change the running state:
1390 you just need to disable the watcher, shutdown all instances with
1391 ``--no-remember``, and when the watcher is activated again it will
1392 restore the correct runtime state for all instances.
1394 See **ganeti**\(7) for a description of ``--submit`` and other common
1399 # gnt-instance shutdown instance1.example.com
1400 # gnt-instance shutdown --all
1407 | [{-t|\--type} *REBOOT-TYPE*]
1408 | [\--ignore-secondaries]
1409 | [\--shutdown-timeout=*N*]
1410 | [\--force-multiple]
1411 | [\--instance \| \--node \| \--primary \| \--secondary \| \--all \|
1412 | \--tags \| \--node-tags \| \--pri-node-tags \| \--sec-node-tags]
1416 Reboots one or more instances. The type of reboot depends on the value
1417 of ``-t (--type)``. A soft reboot does a hypervisor reboot, a hard reboot
1418 does a instance stop, recreates the hypervisor config for the instance
1419 and starts the instance. A full reboot does the equivalent of
1420 **gnt-instance shutdown && gnt-instance startup**. The default is
1423 For the hard reboot the option ``--ignore-secondaries`` ignores errors
1424 for the secondary node while re-assembling the instance disks.
1426 The ``--instance``, ``--node``, ``--primary``, ``--secondary``,
1427 ``--all``, ``--tags``, ``--node-tags``, ``--pri-node-tags`` and
1428 ``--sec-node-tags`` options are similar as for the **startup** command
1429 and they influence the actual instances being rebooted.
1431 The ``--shutdown-timeout`` is used to specify how much time to wait
1432 before forcing the shutdown (xm destroy in xen, killing the kvm
1433 process, for kvm). By default two minutes are given to each instance
1436 The ``--force-multiple`` will skip the interactive confirmation in the
1437 case the more than one instance will be affected.
1439 See **ganeti**\(7) for a description of ``--submit`` and other common
1444 # gnt-instance reboot instance1.example.com
1445 # gnt-instance reboot --type=full instance1.example.com
1451 **console** [\--show-cmd] {*instance*}
1453 Connects to the console of the given instance. If the instance is not
1454 up, an error is returned. Use the ``--show-cmd`` option to display the
1455 command instead of executing it.
1457 For HVM instances, this will attempt to connect to the serial console
1458 of the instance. To connect to the virtualized "physical" console of a
1459 HVM instance, use a VNC client with the connection info from the
1462 For Xen/kvm instances, if the instance is paused, this attempts to
1463 unpause the instance after waiting a few seconds for the connection to
1464 the console to be made.
1468 # gnt-instance console instance1.example.com
1477 **replace-disks** [\--submit] [\--early-release] [\--ignore-ipolicy] {-p}
1478 [\--disks *idx*] {*instance*}
1480 **replace-disks** [\--submit] [\--early-release] [\--ignore-ipolicy] {-s}
1481 [\--disks *idx*] {*instance*}
1483 **replace-disks** [\--submit] [\--early-release] [\--ignore-ipolicy]
1484 {{-I\|\--iallocator} *name* \| {{-n|\--new-secondary} *node* } {*instance*}
1486 **replace-disks** [\--submit] [\--early-release] [\--ignore-ipolicy]
1487 {-a\|\--auto} {*instance*}
1489 This command is a generalized form for replacing disks. It is
1490 currently only valid for the mirrored (DRBD) disk template.
1492 The first form (when passing the ``-p`` option) will replace the disks
1493 on the primary, while the second form (when passing the ``-s`` option
1494 will replace the disks on the secondary node. For these two cases (as
1495 the node doesn't change), it is possible to only run the replace for a
1496 subset of the disks, using the option ``--disks`` which takes a list
1497 of comma-delimited disk indices (zero-based), e.g. 0,2 to replace only
1498 the first and third disks.
1500 The third form (when passing either the ``--iallocator`` or the
1501 ``--new-secondary`` option) is designed to change secondary node of the
1502 instance. Specifying ``--iallocator`` makes the new secondary be
1503 selected automatically by the specified allocator plugin (use ``.`` to
1504 indicate the default allocator), otherwise the new secondary node will
1505 be the one chosen manually via the ``--new-secondary`` option.
1507 Note that it is not possible to select an offline or drained node as a
1510 The fourth form (when using ``--auto``) will automatically determine
1511 which disks of an instance are faulty and replace them within the same
1512 node. The ``--auto`` option works only when an instance has only
1513 faulty disks on either the primary or secondary node; it doesn't work
1514 when both sides have faulty disks.
1516 The ``--early-release`` changes the code so that the old storage on
1517 secondary node(s) is removed early (before the resync is completed)
1518 and the internal Ganeti locks for the current (and new, if any)
1519 secondary node are also released, thus allowing more parallelism in
1520 the cluster operation. This should be used only when recovering from a
1521 disk failure on the current secondary (thus the old storage is already
1522 broken) or when the storage on the primary node is known to be fine
1523 (thus we won't need the old storage for potential recovery).
1525 The ``--ignore-ipolicy`` let the command ignore instance policy
1526 violations if replace-disks changes groups and the instance would
1527 violate the new groups instance policy.
1529 See **ganeti**\(7) for a description of ``--submit`` and other common
1535 **activate-disks** [\--submit] [\--ignore-size] [\--wait-for-sync] {*instance*}
1537 Activates the block devices of the given instance. If successful, the
1538 command will show the location and name of the block devices::
1540 node1.example.com:disk/0:/dev/drbd0
1541 node1.example.com:disk/1:/dev/drbd1
1544 In this example, *node1.example.com* is the name of the node on which
1545 the devices have been activated. The *disk/0* and *disk/1* are the
1546 Ganeti-names of the instance disks; how they are visible inside the
1547 instance is hypervisor-specific. */dev/drbd0* and */dev/drbd1* are the
1548 actual block devices as visible on the node.
1550 The ``--ignore-size`` option can be used to activate disks ignoring
1551 the currently configured size in Ganeti. This can be used in cases
1552 where the configuration has gotten out of sync with the real-world
1553 (e.g. after a partially-failed grow-disk operation or due to rounding
1554 in LVM devices). This should not be used in normal cases, but only
1555 when activate-disks fails without it.
1557 The ``--wait-for-sync`` option will ensure that the command returns only
1558 after the instance's disks are synchronised (mostly for DRBD); this can
1559 be useful to ensure consistency, as otherwise there are no commands that
1560 can wait until synchronisation is done. However when passing this
1561 option, the command will have additional output, making it harder to
1562 parse the disk information.
1564 Note that it is safe to run this command while the instance is already
1567 See **ganeti**\(7) for a description of ``--submit`` and other common
1573 **deactivate-disks** [-f] [\--submit] {*instance*}
1575 De-activates the block devices of the given instance. Note that if you
1576 run this command for an instance with a drbd disk template, while it
1577 is running, it will not be able to shutdown the block devices on the
1578 primary node, but it will shutdown the block devices on the secondary
1579 nodes, thus breaking the replication.
1581 The ``-f``/``--force`` option will skip checks that the instance is
1582 down; in case the hypervisor is confused and we can't talk to it,
1583 normally Ganeti will refuse to deactivate the disks, but with this
1584 option passed it will skip this check and directly try to deactivate
1585 the disks. This can still fail due to the instance actually running or
1588 See **ganeti**\(7) for a description of ``--submit`` and other common
1594 | **grow-disk** [\--no-wait-for-sync] [\--submit] [\--absolute]
1595 | {*instance*} {*disk*} {*amount*}
1597 Grows an instance's disk. This is only possible for instances having a
1598 plain, drbd, file, sharedfile, rbd or ext disk template. For the ext
1599 template to work, the ExtStorage provider should also support growing.
1600 This means having a ``grow`` script that actually grows the volume of
1601 the external shared storage.
1603 Note that this command only change the block device size; it will not
1604 grow the actual filesystems, partitions, etc. that live on that
1605 disk. Usually, you will need to:
1607 #. use **gnt-instance grow-disk**
1609 #. reboot the instance (later, at a convenient time)
1611 #. use a filesystem resizer, such as **ext2online**\(8) or
1612 **xfs\_growfs**\(8) to resize the filesystem, or use **fdisk**\(8) to
1613 change the partition table on the disk
1615 The *disk* argument is the index of the instance disk to grow. The
1616 *amount* argument is given as a number which can have a suffix (like the
1617 disk size in instance create); if the suffix is missing, the value will
1618 be interpreted as mebibytes.
1620 By default, the *amount* value represents the desired increase in the
1621 disk size (e.g. an amount of 1G will take a disk of size 3G to 4G). If
1622 the optional ``--absolute`` parameter is passed, then the *amount*
1623 argument doesn't represent the delta, but instead the desired final disk
1624 size (e.g. an amount of 8G will take a disk of size 4G to 8G).
1626 For instances with a drbd template, note that the disk grow operation
1627 might complete on one node but fail on the other; this will leave the
1628 instance with different-sized LVs on the two nodes, but this will not
1629 create problems (except for unused space).
1631 If you do not want gnt-instance to wait for the new disk region to be
1632 synced, use the ``--no-wait-for-sync`` option.
1634 See **ganeti**\(7) for a description of ``--submit`` and other common
1637 Example (increase the first disk for instance1 by 16GiB)::
1639 # gnt-instance grow-disk instance1.example.com 0 16g
1641 Example for increasing the disk size to a certain size::
1643 # gnt-instance grow-disk --absolute instance1.example.com 0 32g
1645 Also note that disk shrinking is not supported; use **gnt-backup
1646 export** and then **gnt-backup import** to reduce the disk size of an
1652 | **recreate-disks** [\--submit]
1653 | [{-n node1:[node2] \| {-I\|\--iallocator *name*}}]
1654 | [\--disk=*N*[:[size=*VAL*][,mode=*ro\|rw*]]] {*instance*}
1656 Recreates all or a subset of disks of the given instance.
1658 Note that this functionality should only be used for missing disks; if
1659 any of the given disks already exists, the operation will fail. While
1660 this is suboptimal, recreate-disks should hopefully not be needed in
1661 normal operation and as such the impact of this is low.
1663 If only a subset should be recreated, any number of ``disk`` options can
1664 be specified. It expects a disk index and an optional list of disk
1665 parameters to change. Only ``size`` and ``mode`` can be changed while
1666 recreating disks. To recreate all disks while changing parameters on
1667 a subset only, a ``--disk`` option must be given for every disk of the
1670 Optionally the instance's disks can be recreated on different
1671 nodes. This can be useful if, for example, the original nodes of the
1672 instance have gone down (and are marked offline), so we can't recreate
1673 on the same nodes. To do this, pass the new node(s) via ``-n`` option,
1674 with a syntax similar to the **add** command. The number of nodes
1675 passed must equal the number of nodes that the instance currently
1676 has. Note that changing nodes is only allowed when all disks are
1677 replaced, e.g. when no ``--disk`` option is passed.
1679 Another method of choosing which nodes to place the instance on is by
1680 using the specified iallocator, passing the ``--iallocator`` option.
1681 The primary and secondary nodes will be chosen by the specified
1682 iallocator plugin, or by the default allocator if ``.`` is specified.
1684 See **ganeti**\(7) for a description of ``--submit`` and other common
1693 | **failover** [-f] [\--ignore-consistency] [\--ignore-ipolicy]
1694 | [\--shutdown-timeout=*N*]
1695 | [{-n|\--target-node} *node* \| {-I|\--iallocator} *name*]
1696 | [\--submit] [\--cleanup]
1699 Failover will stop the instance (if running), change its primary node,
1700 and if it was originally running it will start it again (on the new
1701 primary). This works for instances with drbd template (in which case you
1702 can only fail to the secondary node) and for externally mirrored
1703 templates (sharedfile, blockdev, rbd and ext) (in which case you can
1704 fail to any other node).
1706 If the instance's disk template is of type sharedfile, blockdev, rbd or
1707 ext, then you can explicitly specify the target node (which can be any
1708 node) using the ``-n`` or ``--target-node`` option, or specify an
1709 iallocator plugin using the ``-I`` or ``--iallocator`` option. If you
1710 omit both, the default iallocator will be used to specify the target
1713 If the instance's disk template is of type drbd, the target node is
1714 automatically selected as the drbd's secondary node. Changing the
1715 secondary node is possible with a replace-disks operation.
1717 Normally the failover will check the consistency of the disks before
1718 failing over the instance. If you are trying to migrate instances off
1719 a dead node, this will fail. Use the ``--ignore-consistency`` option
1720 for this purpose. Note that this option can be dangerous as errors in
1721 shutting down the instance will be ignored, resulting in possibly
1722 having the instance running on two machines in parallel (on
1723 disconnected DRBD drives).
1725 The ``--shutdown-timeout`` is used to specify how much time to wait
1726 before forcing the shutdown (xm destroy in xen, killing the kvm
1727 process, for kvm). By default two minutes are given to each instance
1730 If ``--ignore-ipolicy`` is given any instance policy violations occuring
1731 during this operation are ignored.
1733 If the ``--cleanup`` option is passed, the operation changes from
1734 performin a failover to attempting recovery from a failed previous failover.
1735 In this mode, Ganeti checks if the instance runs on the correct node (and
1736 updates its configuration if not) and ensures the instances' disks
1737 are configured correctly.
1739 See **ganeti**\(7) for a description of ``--submit`` and other common
1744 # gnt-instance failover instance1.example.com
1746 For externally mirrored templates also ``-n`` is available::
1748 # gnt-instance failover -n node3.example.com instance1.example.com
1754 | **migrate** [-f] [\--allow-failover] [\--non-live]
1755 | [\--migration-mode=live\|non-live] [\--ignore-ipolicy]
1756 | [\--no-runtime-changes] [\--submit]
1757 | [{-n|\--target-node} *node* \| {-I|\--iallocator} *name*] {*instance*}
1759 | **migrate** [-f] \--cleanup [\--submit] {*instance*}
1761 Migrate will move the instance to its secondary node without shutdown.
1762 As with failover, it works for instances having the drbd disk template
1763 or an externally mirrored disk template type such as sharedfile,
1764 blockdev, rbd or ext.
1766 If the instance's disk template is of type sharedfile, blockdev, rbd or
1767 ext, then you can explicitly specify the target node (which can be any
1768 node) using the ``-n`` or ``--target-node`` option, or specify an
1769 iallocator plugin using the ``-I`` or ``--iallocator`` option. If you
1770 omit both, the default iallocator will be used to specify the target
1771 node. Alternatively, the default iallocator can be requested by
1772 specifying ``.`` as the name of the plugin.
1774 If the instance's disk template is of type drbd, the target node is
1775 automatically selected as the drbd's secondary node. Changing the
1776 secondary node is possible with a replace-disks operation.
1778 The migration command needs a perfectly healthy instance for drbd
1779 instances, as we rely on the dual-master capability of drbd8 and the
1780 disks of the instance are not allowed to be degraded.
1782 The ``--non-live`` and ``--migration-mode=non-live`` options will
1783 switch (for the hypervisors that support it) between a "fully live"
1784 (i.e. the interruption is as minimal as possible) migration and one in
1785 which the instance is frozen, its state saved and transported to the
1786 remote node, and then resumed there. This all depends on the
1787 hypervisor support for two different methods. In any case, it is not
1788 an error to pass this parameter (it will just be ignored if the
1789 hypervisor doesn't support it). The option ``--migration-mode=live``
1790 option will request a fully-live migration. The default, when neither
1791 option is passed, depends on the hypervisor parameters (and can be
1792 viewed with the **gnt-cluster info** command).
1794 If the ``--cleanup`` option is passed, the operation changes from
1795 migration to attempting recovery from a failed previous migration. In
1796 this mode, Ganeti checks if the instance runs on the correct node (and
1797 updates its configuration if not) and ensures the instances' disks
1798 are configured correctly. In this mode, the ``--non-live`` option is
1801 The option ``-f`` will skip the prompting for confirmation.
1803 If ``--allow-failover`` is specified it tries to fallback to failover if
1804 it already can determine that a migration won't work (e.g. if the
1805 instance is shut down). Please note that the fallback will not happen
1806 during execution. If a migration fails during execution it still fails.
1808 If ``--ignore-ipolicy`` is given any instance policy violations occuring
1809 during this operation are ignored.
1811 The ``--no-runtime-changes`` option forbids migrate to alter an
1812 instance's runtime before migrating it (eg. ballooning an instance
1813 down because the target node doesn't have enough available memory).
1815 If an instance has the backend parameter ``always_failover`` set to
1816 true, then the migration is automatically converted into a failover.
1818 See **ganeti**\(7) for a description of ``--submit`` and other common
1821 Example (and expected output)::
1823 # gnt-instance migrate instance1
1824 Instance instance1 will be migrated. Note that migration
1825 might impact the instance if anything goes wrong (e.g. due to bugs in
1826 the hypervisor). Continue?
1828 Migrating instance instance1.example.com
1829 * checking disk consistency between source and target
1830 * switching node node2.example.com to secondary mode
1831 * changing into standalone mode
1832 * changing disks into dual-master mode
1833 * wait until resync is done
1834 * preparing node2.example.com to accept the instance
1835 * migrating instance to node2.example.com
1836 * switching node node1.example.com to secondary mode
1837 * wait until resync is done
1838 * changing into standalone mode
1839 * changing disks into single-master mode
1840 * wait until resync is done
1848 | **move** [-f] [\--ignore-consistency]
1849 | [-n *node*] [\--shutdown-timeout=*N*] [\--submit] [\--ignore-ipolicy]
1852 Move will move the instance to an arbitrary node in the cluster. This
1853 works only for instances having a plain or file disk template.
1855 Note that since this operation is done via data copy, it will take a
1856 long time for big disks (similar to replace-disks for a drbd
1859 The ``--shutdown-timeout`` is used to specify how much time to wait
1860 before forcing the shutdown (e.g. ``xm destroy`` in XEN, killing the
1861 kvm process for KVM, etc.). By default two minutes are given to each
1864 The ``--ignore-consistency`` option will make Ganeti ignore any errors
1865 in trying to shutdown the instance on its node; useful if the
1866 hypervisor is broken and you want to recover the data.
1868 If ``--ignore-ipolicy`` is given any instance policy violations occuring
1869 during this operation are ignored.
1871 See **ganeti**\(7) for a description of ``--submit`` and other common
1876 # gnt-instance move -n node3.example.com instance1.example.com
1882 | **change-group** [\--submit]
1883 | [\--iallocator *NAME*] [\--to *GROUP*...] {*instance*}
1885 This command moves an instance to another node group. The move is
1886 calculated by an iallocator, either given on the command line or as a
1889 If no specific destination groups are specified using ``--to``, all
1890 groups except the one containing the instance are considered.
1892 See **ganeti**\(7) for a description of ``--submit`` and other common
1897 # gnt-instance change-group -I hail --to rack2 inst1.example.com
1906 **add-tags** [\--from *file*] {*instancename*} {*tag*...}
1908 Add tags to the given instance. If any of the tags contains invalid
1909 characters, the entire operation will abort.
1911 If the ``--from`` option is given, the list of tags will be extended
1912 with the contents of that file (each line becomes a tag). In this
1913 case, there is not need to pass tags on the command line (if you do,
1914 both sources will be used). A file name of ``-`` will be interpreted
1920 **list-tags** {*instancename*}
1922 List the tags of the given instance.
1927 **remove-tags** [\--from *file*] {*instancename*} {*tag*...}
1929 Remove tags from the given instance. If any of the tags are not
1930 existing on the node, the entire operation will abort.
1932 If the ``--from`` option is given, the list of tags to be removed will
1933 be extended with the contents of that file (each line becomes a tag).
1934 In this case, there is not need to pass tags on the command line (if
1935 you do, tags from both sources will be removed). A file name of ``-``
1936 will be interpreted as stdin.
1938 .. vim: set textwidth=72 :