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}]
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 enabled
470 PAE support for this instance. The default is false, disabling PAE
474 Valid for the Xen HVM and KVM hypervisors.
476 A boolean option that specifies if the instance should be started
477 with its clock set to the localtime of the machine (when true) or
478 to the UTC (When false). The default is false, which is useful for
479 Linux/Unix machines; for Windows OSes, it is recommended to enable
483 Valid for the Xen PVM and KVM hypervisors.
485 This option specifies the path (on the node) to the kernel to boot
486 the instance with. Xen PVM instances always require this, while for
487 KVM if this option is empty, it will cause the machine to load the
488 kernel from its disks (and the boot will be done accordingly to
492 Valid for the Xen PVM and KVM hypervisors.
494 This options specifies extra arguments to the kernel that will be
495 loaded. device. This is always used for Xen PVM, while for KVM it
496 is only used if the ``kernel_path`` option is also specified.
498 The default setting for this value is simply ``"ro"``, which
499 mounts the root disk (initially) in read-only one. For example,
500 setting this to single will cause the instance to start in
504 Valid for the Xen PVM and KVM hypervisors.
506 This option specifies the path (on the node) to the initrd to boot
507 the instance with. Xen PVM instances can use this always, while
508 for KVM if this option is only used if the ``kernel_path`` option
509 is also specified. You can pass here either an absolute filename
510 (the path to the initrd) if you want to use an initrd, or use the
511 format no\_initrd\_path for no initrd.
514 Valid for the Xen PVM and KVM hypervisors.
516 This options specifies the name of the root device. This is always
517 needed for Xen PVM, while for KVM it is only used if the
518 ``kernel_path`` option is also specified.
520 Please note, that if this setting is an empty string and the
521 hypervisor is Xen it will not be written to the Xen configuration
525 Valid for the KVM hypervisor.
527 This boolean option specifies whether to emulate a serial console
528 for the instance. Note that some versions of KVM have a bug that
529 will make an instance hang when configured to use the serial console
530 unless a connection is made to it within about 2 seconds of the
531 instance's startup. For such case it's recommended to disable this
532 option, which is enabled by default.
535 Valid for the KVM hypervisor.
537 This integer option specifies the speed of the serial console.
538 Common values are 9600, 19200, 38400, 57600 and 115200: choose the
539 one which works on your system. (The default is 38400 for historical
540 reasons, but newer versions of kvm/qemu work with 115200)
543 Valid for the KVM hypervisor.
545 The disk cache mode. It can be either default to not pass any
546 cache option to KVM, or one of the KVM cache modes: none (for
547 direct I/O), writethrough (to use the host cache but report
548 completion to the guest only when the host has committed the
549 changes to disk) or writeback (to use the host cache and report
550 completion as soon as the data is in the host cache). Note that
551 there are special considerations for the cache mode depending on
552 version of KVM used and disk type (always raw file under Ganeti),
553 please refer to the KVM documentation for more details.
556 Valid for the KVM hypervisor.
558 The security model for kvm. Currently one of *none*, *user* or
559 *pool*. Under *none*, the default, nothing is done and instances
560 are run as the Ganeti daemon user (normally root).
562 Under *user* kvm will drop privileges and become the user
563 specified by the security\_domain parameter.
565 Under *pool* a global cluster pool of users will be used, making
566 sure no two instances share the same user on the same node. (this
567 mode is not implemented yet)
570 Valid for the KVM hypervisor.
572 Under security model *user* the username to run the instance
573 under. It must be a valid username existing on the host.
575 Cannot be set under security model *none* or *pool*.
578 Valid for the KVM hypervisor.
580 If *enabled* the -enable-kvm flag is passed to kvm. If *disabled*
581 -disable-kvm is passed. If unset no flag is passed, and the
582 default running mode for your kvm binary will be used.
585 Valid for the KVM hypervisor.
587 This option passes the -mem-path argument to kvm with the path (on
588 the node) to the mount point of the hugetlbfs file system, along
589 with the -mem-prealloc argument too.
592 Valid for the KVM hypervisor.
594 This boolean option determines whether to run the KVM instance in a
597 If it is set to ``true``, an empty directory is created before
598 starting the instance and its path is passed via the -chroot flag
599 to kvm. The directory is removed when the instance is stopped.
601 It is set to ``false`` by default.
604 Valid for the KVM hypervisor.
606 The maximum amount of time (in ms) a KVM instance is allowed to be
607 frozen during a live migration, in order to copy dirty memory
608 pages. Default value is 30ms, but you may need to increase this
609 value for busy instances.
611 This option is only effective with kvm versions >= 87 and qemu-kvm
615 Valid for the Xen, KVM and LXC hypervisors.
617 The processes belonging to the given instance are only scheduled
618 on the specified CPUs.
620 The format of the mask can be given in three forms. First, the word
621 "all", which signifies the common case where all VCPUs can live on
622 any CPU, based on the hypervisor's decisions.
624 Second, a comma-separated list of CPU IDs or CPU ID ranges. The
625 ranges are defined by a lower and higher boundary, separated by a
626 dash, and the boundaries are inclusive. In this form, all VCPUs of
627 the instance will be mapped on the selected list of CPUs. Example:
628 ``0-2,5``, mapping all VCPUs (no matter how many) onto physical CPUs
631 The last form is used for explicit control of VCPU-CPU pinnings. In
632 this form, the list of VCPU mappings is given as a colon (:)
633 separated list, whose elements are the possible values for the
634 second or first form above. In this form, the number of elements in
635 the colon-separated list _must_ equal the number of VCPUs of the
642 # Map the entire instance to CPUs 0-2
643 gnt-instance modify -H cpu_mask=0-2 my-inst
645 # Map vCPU 0 to physical CPU 1 and vCPU 1 to CPU 3 (assuming 2 vCPUs)
646 gnt-instance modify -H cpu_mask=1:3 my-inst
648 # Pin vCPU 0 to CPUs 1 or 2, and vCPU 1 to any CPU
649 gnt-instance modify -H cpu_mask=1-2:all my-inst
651 # Pin vCPU 0 to any CPU, vCPU 1 to CPUs 1, 3, 4 or 5, and CPU 2 to
652 # CPU 0 (backslashes for escaping the comma)
653 gnt-instance modify -H cpu_mask=all:1\\,3-5:0 my-inst
655 # Pin entire VM to CPU 0
656 gnt-instance modify -H cpu_mask=0 my-inst
658 # Turn off CPU pinning (default setting)
659 gnt-instance modify -H cpu_mask=all my-inst
662 Valid for the Xen hypervisor.
664 Set the maximum amount of cpu usage by the VM. The value is a percentage
665 between 0 and (100 * number of VCPUs). Default cap is 0: unlimited.
668 Valid for the Xen hypervisor.
670 Set the cpu time ratio to be allocated to the VM. Valid values are
671 between 1 and 65535. Default weight is 256.
674 Valid for the KVM hypervisor.
676 This option specifies the usb mouse type to be used. It can be
677 "mouse" or "tablet". When using VNC it's recommended to set it to
681 Valid for the KVM hypervisor.
683 This option specifies the keyboard mapping to be used. It is only
684 needed when using the VNC console. For example: "fr" or "en-gb".
687 Valid for Xen PVM, Xen HVM and KVM hypervisors.
689 Normally if an instance reboots, the hypervisor will restart it. If
690 this option is set to ``exit``, the hypervisor will treat a reboot
691 as a shutdown instead.
693 It is set to ``reboot`` by default.
696 Valid for the KVM hypervisor.
698 Number of emulated CPU cores.
701 Valid for the KVM hypervisor.
703 Number of emulated CPU threads.
706 Valid for the KVM hypervisor.
708 Number of emulated CPU sockets.
711 Valid for the KVM hypervisor.
713 Comma separated list of emulated sounds cards, or "all" to enable
714 all the available ones.
717 Valid for the KVM hypervisor.
719 Comma separated list of usb devices. These can be emulated devices
720 or passthrough ones, and each one gets passed to kvm with its own
721 ``-usbdevice`` option. See the **qemu**\(1) manpage for the syntax
722 of the possible components.
725 Valid for the KVM hypervisor.
727 Emulated vga mode, passed the the kvm -vga option.
730 Valid for the KVM hypervisor.
732 Any other option to the KVM hypervisor, useful tweaking anything
733 that Ganeti doesn't support. Note that values set with this
734 parameter are split on a space character and currently don't support
738 Valid for the KVM hypervisor.
740 Use in case an instance must be booted with an exact type of
741 machine version (due to e.g. outdated drivers). In case it's not set
742 the default version supported by your version of kvm is used.
745 Valid for the KVM hypervisor.
747 Path to the userspace KVM (or qemu) program.
750 Valid for the KVM hypervisor.
752 This boolean option determines whether the tap devices used by the
753 KVM paravirtual nics (virtio-net) will get created with VNET_HDR
754 (IFF_VNET_HDR) support.
756 If set to false, it effectively disables offloading on the virio-net
757 interfaces, which prevents host kernel tainting and log flooding,
758 when dealing with broken or malicious virtio-net drivers.
760 It is set to ``true`` by default.
762 The ``-O (--os-parameters)`` option allows customisation of the OS
763 parameters. The actual parameter names and values depends on the OS
764 being used, but the syntax is the same key=value. For example, setting
765 a hypothetical ``dhcp`` parameter to yes can be achieved by::
767 gnt-instance add -O dhcp=yes ...
769 The ``-I (--iallocator)`` option specifies the instance allocator plugin
770 to use (``.`` means the default allocator). If you pass in this option
771 the allocator will select nodes for this instance automatically, so you
772 don't need to pass them with the ``-n`` option. For more information
773 please refer to the instance allocator documentation.
775 The ``-t (--disk-template)`` options specifies the disk layout type
776 for the instance. The available choices are:
779 This creates an instance with no disks. Its useful for testing only
780 (or other special cases).
783 Disk devices will be regular files.
786 Disk devices will be regulare files on a shared directory.
789 Disk devices will be logical volumes.
792 Disk devices will be drbd (version 8.x) on top of lvm volumes.
795 Disk devices will be rbd volumes residing inside a RADOS cluster.
798 Disk devices will be adopted pre-existent block devices.
801 Disk devices will be provided by external shared storage,
802 through the ExtStorage Interface using ExtStorage providers.
804 The optional second value of the ``-n (--node)`` is used for the drbd
805 template type and specifies the remote node.
807 If you do not want gnt-instance to wait for the disk mirror to be
808 synced, use the ``--no-wait-for-sync`` option.
810 The ``--file-storage-dir`` specifies the relative path under the
811 cluster-wide file storage directory to store file-based disks. It is
812 useful for having different subdirectories for different
813 instances. The full path of the directory where the disk files are
814 stored will consist of cluster-wide file storage directory + optional
815 subdirectory + instance name. Example:
816 ``@RPL_FILE_STORAGE_DIR@/mysubdir/instance1.example.com``. This
817 option is only relevant for instances using the file storage backend.
819 The ``--file-driver`` specifies the driver to use for file-based
820 disks. Note that currently these drivers work with the xen hypervisor
821 only. This option is only relevant for instances using the file
822 storage backend. The available choices are:
825 Kernel loopback driver. This driver uses loopback devices to
826 access the filesystem within the file. However, running I/O
827 intensive applications in your instance using the loop driver
828 might result in slowdowns. Furthermore, if you use the loopback
829 driver consider increasing the maximum amount of loopback devices
830 (on most systems it's 8) using the max\_loop param.
833 The blktap driver (for Xen hypervisors). In order to be able to
834 use the blktap driver you should check if the 'blktapctrl' user
835 space disk agent is running (usually automatically started via
836 xend). This user-level disk I/O interface has the advantage of
837 better performance. Especially if you use a network file system
838 (e.g. NFS) to store your instances this is the recommended choice.
840 If ``--ignore-ipolicy`` is given any instance policy violations occuring
841 during this operation are ignored.
843 See **ganeti**\(7) for a description of ``--submit`` and other common
848 # gnt-instance add -t file --disk 0:size=30g -B maxmem=512 -o debian-etch \
849 -n node1.example.com --file-storage-dir=mysubdir instance1.example.com
850 # gnt-instance add -t plain --disk 0:size=30g -B maxmem=1024,minmem=512 \
851 -o debian-etch -n node1.example.com instance1.example.com
852 # gnt-instance add -t plain --disk 0:size=30g --disk 1:size=100g,vg=san \
853 -B maxmem=512 -o debian-etch -n node1.example.com instance1.example.com
854 # gnt-instance add -t drbd --disk 0:size=30g -B maxmem=512 -o debian-etch \
855 -n node1.example.com:node2.example.com instance2.example.com
856 # gnt-instance add -t rbd --disk 0:size=30g -B maxmem=512 -o debian-etch \
857 -n node1.example.com instance1.example.com
858 # gnt-instance add -t ext --disk 0:size=30g,provider=pvdr1 -B maxmem=512 \
859 -o debian-etch -n node1.example.com instance1.example.com
860 # gnt-instance add -t ext --disk 0:size=30g,provider=pvdr1,param1=val1 \
861 --disk 1:size=40g,provider=pvdr2,param2=val2,param3=val3 -B maxmem=512 \
862 -o debian-etch -n node1.example.com instance1.example.com
868 **batch-create** {instances\_file.json}
870 This command (similar to the Ganeti 1.2 **batcher** tool) submits
871 multiple instance creation jobs based on a definition file. The
872 instance configurations do not encompass all the possible options for
873 the **add** command, but only a subset.
875 The instance file should be a valid-formed JSON file, containing a
876 dictionary with instance name and instance parameters. The accepted
880 The size of the disks of the instance.
883 The disk template to use for the instance, the same as in the
887 A dictionary of backend parameters.
890 A dictionary with a single key (the hypervisor name), and as value
891 the hypervisor options. If not passed, the default hypervisor and
892 hypervisor options will be inherited.
895 Specifications for the one NIC that will be created for the
896 instance. 'bridge' is also accepted as a backwards compatible
900 List of NICs that will be created for the instance. Each entry
901 should be a dict, with mac, ip, mode and link as possible keys.
902 Please don't provide the "mac, ip, mode, link" parent keys if you
903 use this method for specifying NICs.
905 primary\_node, secondary\_node
906 The primary and optionally the secondary node to use for the
907 instance (in case an iallocator script is not used).
910 Instead of specifying the nodes, an iallocator script can be used
911 to automatically compute them.
914 whether to start the instance
917 Skip the check for already-in-use instance; see the description in
918 the **add** command for details.
921 Skip the name check for instances; see the description in the
922 **add** command for details.
924 file\_storage\_dir, file\_driver
925 Configuration for the file disk type, see the **add** command for
929 A simple definition for one instance can be (with most of the
930 parameters taken from the cluster defaults)::
936 "disk_size": ["25G"],
942 "disk_size": ["25G"],
943 "iallocator": "dumb",
944 "hypervisor": "xen-hvm",
945 "hvparams": {"acpi": true},
946 "backend": {"maxmem": 512, "minmem": 256}
950 The command will display the job id for each submitted instance, as
953 # gnt-instance batch-create instances.json
960 **remove** [\--ignore-failures] [\--shutdown-timeout=*N*] [\--submit]
961 [\--force] {*instance*}
963 Remove an instance. This will remove all data from the instance and
964 there is *no way back*. If you are not sure if you use an instance
965 again, use **shutdown** first and leave it in the shutdown state for a
968 The ``--ignore-failures`` option will cause the removal to proceed
969 even in the presence of errors during the removal of the instance
970 (e.g. during the shutdown or the disk removal). If this option is not
971 given, the command will stop at the first error.
973 The ``--shutdown-timeout`` is used to specify how much time to wait
974 before forcing the shutdown (e.g. ``xm destroy`` in Xen, killing the
975 kvm process for KVM, etc.). By default two minutes are given to each
978 The ``--force`` option is used to skip the interactive confirmation.
980 See **ganeti**\(7) for a description of ``--submit`` and other common
985 # gnt-instance remove instance1.example.com
992 | [\--no-headers] [\--separator=*SEPARATOR*] [\--units=*UNITS*] [-v]
993 | [{-o|\--output} *[+]FIELD,...*] [\--filter] [instance...]
995 Shows the currently configured instances with memory usage, disk
996 usage, the node they are running on, and their run status.
998 The ``--no-headers`` option will skip the initial header line. The
999 ``--separator`` option takes an argument which denotes what will be
1000 used between the output fields. Both these options are to help
1003 The units used to display the numeric values in the output varies,
1004 depending on the options given. By default, the values will be
1005 formatted in the most appropriate unit. If the ``--separator`` option
1006 is given, then the values are shown in mebibytes to allow parsing by
1007 scripts. In both cases, the ``--units`` option can be used to enforce
1008 a given output unit.
1010 The ``-v`` option activates verbose mode, which changes the display of
1011 special field states (see **ganeti**\(7)).
1013 The ``-o (--output)`` option takes a comma-separated list of output
1014 fields. The available fields and their meaning are:
1016 @QUERY_FIELDS_INSTANCE@
1018 If the value of the option starts with the character ``+``, the new
1019 field(s) will be added to the default list. This allows one to quickly
1020 see the default list plus a few other fields, instead of retyping the
1021 entire list of fields.
1023 There is a subtle grouping about the available output fields: all
1024 fields except for ``oper_state``, ``oper_ram``, ``oper_vcpus`` and
1025 ``status`` are configuration value and not run-time values. So if you
1026 don't select any of the these fields, the query will be satisfied
1027 instantly from the cluster configuration, without having to ask the
1028 remote nodes for the data. This can be helpful for big clusters when
1029 you only want some data and it makes sense to specify a reduced set of
1032 If exactly one argument is given and it appears to be a query filter
1033 (see **ganeti**\(7)), the query result is filtered accordingly. For
1034 ambiguous cases (e.g. a single field name as a filter) the ``--filter``
1035 (``-F``) option forces the argument to be treated as a filter (e.g.
1036 ``gnt-instance list -F admin_state``).
1038 The default output field list is: ``name``, ``os``, ``pnode``,
1039 ``admin_state``, ``oper_state``, ``oper_ram``.
1045 **list-fields** [field...]
1047 Lists available fields for instances.
1053 **info** [-s \| \--static] [\--roman] {\--all \| *instance*}
1055 Show detailed information about the given instance(s). This is
1056 different from **list** as it shows detailed data about the instance's
1057 disks (especially useful for the drbd disk template).
1059 If the option ``-s`` is used, only information available in the
1060 configuration file is returned, without querying nodes, making the
1063 Use the ``--all`` to get info about all instances, rather than
1064 explicitly passing the ones you're interested in.
1066 The ``--roman`` option can be used to cause envy among people who like
1067 ancient cultures, but are stuck with non-latin-friendly cluster
1068 virtualization technologies.
1074 | [{-H|\--hypervisor-parameters} *HYPERVISOR\_PARAMETERS*]
1075 | [{-B|\--backend-parameters} *BACKEND\_PARAMETERS*]
1076 | [{-m|\--runtime-memory} *SIZE*]
1077 | [\--net add[:options...] \|
1078 | \--net [*N*:]add[,options...] \|
1079 | \--net [*ID*:]remove \|
1080 | \--net *ID*:modify[,options...]]
1081 | [\--disk add:size=*SIZE*[,options...] \|
1082 | \--disk *N*:add,size=*SIZE*[,options...] \|
1083 | \--disk *N*:add,size=*SIZE*,provider=*PROVIDER*[,options...][,param=*value*... ] \|
1084 | \--disk *ID*:modify[,options...]
1085 | \--disk [*ID*:]remove]
1086 | [{-t|\--disk-template} plain | {-t|\--disk-template} drbd -n *new_secondary*] [\--no-wait-for-sync]
1087 | [\--new-primary=*node*]
1088 | [\--os-type=*OS* [\--force-variant]]
1089 | [{-O|\--os-parameters} *param*=*value*... ]
1090 | [\--offline \| \--online]
1092 | [\--ignore-ipolicy]
1095 Modifies the memory size, number of vcpus, ip address, MAC address
1096 and/or NIC parameters for an instance. It can also add and remove
1097 disks and NICs to/from the instance. Note that you need to give at
1098 least one of the arguments, otherwise the command complains.
1100 The ``-H (--hypervisor-parameters)``, ``-B (--backend-parameters)``
1101 and ``-O (--os-parameters)`` options specifies hypervisor, backend and
1102 OS parameter options in the form of name=value[,...]. For details
1103 which options can be specified, see the **add** command.
1105 The ``-t (--disk-template)`` option will change the disk template of
1106 the instance. Currently only conversions between the plain and drbd
1107 disk templates are supported, and the instance must be stopped before
1108 attempting the conversion. When changing from the plain to the drbd
1109 disk template, a new secondary node must be specified via the ``-n``
1110 option. The option ``--no-wait-for-sync`` can be used when converting
1111 to the ``drbd`` template in order to make the instance available for
1112 startup before DRBD has finished resyncing.
1114 The ``-m (--runtime-memory)`` option will change an instance's runtime
1115 memory to the given size (in MB if a different suffix is not specified),
1116 by ballooning it up or down to the new value.
1118 The ``--disk add:size=*SIZE*,[options..]`` option adds a disk to the
1119 instance, and ``--disk *N*:add:size=*SIZE*,[options..]`` will add a disk
1120 to the the instance at a specific index. The available options are the
1121 same as in the **add** command(``mode``, ``name``, ``vg``, ``metavg``).
1122 When adding an ExtStorage disk the ``provider=*PROVIDER*`` option is
1123 also mandatory and specifies the ExtStorage provider. Also, for
1124 ExtStorage disks arbitrary parameters can be passed as additional comma
1125 separated options, same as in the **add** command. -The ``--disk remove``
1126 option will remove the last disk of the instance. Use
1127 ``--disk `` *ID*``:remove`` to remove a disk by its identifier. *ID*
1128 can be the index of the disk, the disks's name or the disks's UUID. The
1129 ``--disk *ID*:modify[,options...]`` wil change the options of the disk.
1130 Available options are:
1133 The access mode. Either ``ro`` (read-only) or the default ``rw`` (read-write).
1136 this option specifies a name for the disk, which can be used as a disk
1137 identifier. An instance can not have two disks with the same name.
1139 The ``--net *N*:add[,options..]`` will add a new network interface to
1140 the instance. The available options are the same as in the **add**
1141 command (``mac``, ``ip``, ``link``, ``mode``, ``network``). The
1142 ``--net *ID*,remove`` will remove the intances' NIC with *ID* identifier,
1143 which can be the index of the NIC, the NIC's name or the NIC's UUID.
1144 The ``--net *ID*:modify[,options..]`` option will change the parameters of
1145 the instance network interface with the *ID* identifier.
1147 The option ``-o (--os-type)`` will change the OS name for the instance
1148 (without reinstallation). In case an OS variant is specified that is
1149 not found, then by default the modification is refused, unless
1150 ``--force-variant`` is passed. An invalid OS will also be refused,
1151 unless the ``--force`` option is given.
1153 The option ``--new-primary`` will set the new primary node of an instance
1154 assuming the disks have already been moved manually. Unless the ``--force``
1155 option is given, it is verified that the instance is no longer running
1156 on its current primary node.
1158 The ``--online`` and ``--offline`` options are used to transition an
1159 instance into and out of the ``offline`` state. An instance can be
1160 turned offline only if it was previously down. The ``--online`` option
1161 fails if the instance was not in the ``offline`` state, otherwise it
1162 changes instance's state to ``down``. These modifications take effect
1165 If ``--ignore-ipolicy`` is given any instance policy violations occuring
1166 during this operation are ignored.
1168 See **ganeti**\(7) for a description of ``--submit`` and other common
1171 Most of the changes take effect at the next restart. If the instance is
1172 running, there is no effect on the instance.
1177 | **reinstall** [{-o|\--os-type} *os-type*] [\--select-os] [-f *force*]
1178 | [\--force-multiple]
1179 | [\--instance \| \--node \| \--primary \| \--secondary \| \--all]
1180 | [{-O|\--os-parameters} *OS\_PARAMETERS*] [\--submit] {*instance*...}
1182 Reinstalls the operating system on the given instance(s). The
1183 instance(s) must be stopped when running this command. If the ``-o
1184 (--os-type)`` is specified, the operating system is changed.
1186 The ``--select-os`` option switches to an interactive OS reinstall.
1187 The user is prompted to select the OS template from the list of
1188 available OS templates. OS parameters can be overridden using ``-O
1189 (--os-parameters)`` (more documentation for this option under the
1192 Since this is a potentially dangerous command, the user will be
1193 required to confirm this action, unless the ``-f`` flag is passed.
1194 When multiple instances are selected (either by passing multiple
1195 arguments or by using the ``--node``, ``--primary``, ``--secondary``
1196 or ``--all`` options), the user must pass the ``--force-multiple``
1197 options to skip the interactive confirmation.
1199 See **ganeti**\(7) for a description of ``--submit`` and other common
1205 | **rename** [\--no-ip-check] [\--no-name-check] [\--submit]
1206 | {*instance*} {*new\_name*}
1208 Renames the given instance. The instance must be stopped when running
1209 this command. The requirements for the new name are the same as for
1210 adding an instance: the new name must be resolvable and the IP it
1211 resolves to must not be reachable (in order to prevent duplicate IPs
1212 the next time the instance is started). The IP test can be skipped if
1213 the ``--no-ip-check`` option is passed.
1215 Note that you can rename an instance to its same name, to force
1216 re-executing the os-specific rename script for that instance, if
1219 The ``--no-name-check`` skips the check for the new instance name via
1220 the resolver (e.g. in DNS or /etc/hosts, depending on your setup) and
1221 that the resolved name matches the provided name. Since the name check
1222 is used to compute the IP address, if you pass this option you must also
1223 pass the ``--no-ip-check`` option.
1225 See **ganeti**\(7) for a description of ``--submit`` and other common
1228 Starting/stopping/connecting to console
1229 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1235 | [\--force] [\--ignore-offline]
1236 | [\--force-multiple] [\--no-remember]
1237 | [\--instance \| \--node \| \--primary \| \--secondary \| \--all \|
1238 | \--tags \| \--node-tags \| \--pri-node-tags \| \--sec-node-tags]
1239 | [{-H|\--hypervisor-parameters} ``key=value...``]
1240 | [{-B|\--backend-parameters} ``key=value...``]
1241 | [\--submit] [\--paused]
1244 Starts one or more instances, depending on the following options. The
1245 four available modes are:
1248 will start the instances given as arguments (at least one argument
1249 required); this is the default selection
1252 will start the instances who have the given node as either primary
1256 will start all instances whose primary node is in the list of nodes
1257 passed as arguments (at least one node required)
1260 will start all instances whose secondary node is in the list of
1261 nodes passed as arguments (at least one node required)
1264 will start all instances in the cluster (no arguments accepted)
1267 will start all instances in the cluster with the tags given as
1271 will start all instances in the cluster on nodes with the tags
1275 will start all instances in the cluster on primary nodes with the
1276 tags given as arguments
1279 will start all instances in the cluster on secondary nodes with the
1280 tags given as arguments
1282 Note that although you can pass more than one selection option, the
1283 last one wins, so in order to guarantee the desired result, don't pass
1284 more than one such option.
1286 Use ``--force`` to start even if secondary disks are failing.
1287 ``--ignore-offline`` can be used to ignore offline primary nodes and
1288 mark the instance as started even if the primary is not available.
1290 The ``--force-multiple`` will skip the interactive confirmation in the
1291 case the more than one instance will be affected.
1293 The ``--no-remember`` option will perform the startup but not change
1294 the state of the instance in the configuration file (if it was stopped
1295 before, Ganeti will still think it needs to be stopped). This can be
1296 used for testing, or for a one shot-start where you don't want the
1297 watcher to restart the instance if it crashes.
1299 The ``-H (--hypervisor-parameters)`` and ``-B (--backend-parameters)``
1300 options specify temporary hypervisor and backend parameters that can
1301 be used to start an instance with modified parameters. They can be
1302 useful for quick testing without having to modify an instance back and
1305 # gnt-instance start -H kernel_args="single" instance1
1306 # gnt-instance start -B maxmem=2048 instance2
1309 The first form will start the instance instance1 in single-user mode,
1310 and the instance instance2 with 2GB of RAM (this time only, unless
1311 that is the actual instance memory size already). Note that the values
1312 override the instance parameters (and not extend them): an instance
1313 with "kernel\_args=ro" when started with -H kernel\_args=single will
1314 result in "single", not "ro single".
1316 The ``--paused`` option is only valid for Xen and kvm hypervisors. This
1317 pauses the instance at the start of bootup, awaiting ``gnt-instance
1318 console`` to unpause it, allowing the entire boot process to be
1319 monitored for debugging.
1321 See **ganeti**\(7) for a description of ``--submit`` and other common
1326 # gnt-instance start instance1.example.com
1327 # gnt-instance start --node node1.example.com node2.example.com
1328 # gnt-instance start --all
1336 | [\--force] [\--force-multiple] [\--ignore-offline] [\--no-remember]
1337 | [\--instance \| \--node \| \--primary \| \--secondary \| \--all \|
1338 | \--tags \| \--node-tags \| \--pri-node-tags \| \--sec-node-tags]
1342 Stops one or more instances. If the instance cannot be cleanly stopped
1343 during a hardcoded interval (currently 2 minutes), it will forcibly
1344 stop the instance (equivalent to switching off the power on a physical
1347 The ``--timeout`` is used to specify how much time to wait before
1348 forcing the shutdown (e.g. ``xm destroy`` in Xen, killing the kvm
1349 process for KVM, etc.). By default two minutes are given to each
1352 The ``--instance``, ``--node``, ``--primary``, ``--secondary``,
1353 ``--all``, ``--tags``, ``--node-tags``, ``--pri-node-tags`` and
1354 ``--sec-node-tags`` options are similar as for the **startup** command
1355 and they influence the actual instances being shutdown.
1357 ``--ignore-offline`` can be used to ignore offline primary nodes and
1358 force the instance to be marked as stopped. This option should be used
1359 with care as it can lead to an inconsistent cluster state.
1361 Use ``--force`` to be able to shutdown an instance even when it's marked
1362 as offline. This is useful is an offline instance ends up in the
1363 ``ERROR_up`` state, for example.
1365 The ``--no-remember`` option will perform the shutdown but not change
1366 the state of the instance in the configuration file (if it was running
1367 before, Ganeti will still thinks it needs to be running). This can be
1368 useful for a cluster-wide shutdown, where some instances are marked as
1369 up and some as down, and you don't want to change the running state:
1370 you just need to disable the watcher, shutdown all instances with
1371 ``--no-remember``, and when the watcher is activated again it will
1372 restore the correct runtime state for all instances.
1374 See **ganeti**\(7) for a description of ``--submit`` and other common
1379 # gnt-instance shutdown instance1.example.com
1380 # gnt-instance shutdown --all
1387 | [{-t|\--type} *REBOOT-TYPE*]
1388 | [\--ignore-secondaries]
1389 | [\--shutdown-timeout=*N*]
1390 | [\--force-multiple]
1391 | [\--instance \| \--node \| \--primary \| \--secondary \| \--all \|
1392 | \--tags \| \--node-tags \| \--pri-node-tags \| \--sec-node-tags]
1396 Reboots one or more instances. The type of reboot depends on the value
1397 of ``-t (--type)``. A soft reboot does a hypervisor reboot, a hard reboot
1398 does a instance stop, recreates the hypervisor config for the instance
1399 and starts the instance. A full reboot does the equivalent of
1400 **gnt-instance shutdown && gnt-instance startup**. The default is
1403 For the hard reboot the option ``--ignore-secondaries`` ignores errors
1404 for the secondary node while re-assembling the instance disks.
1406 The ``--instance``, ``--node``, ``--primary``, ``--secondary``,
1407 ``--all``, ``--tags``, ``--node-tags``, ``--pri-node-tags`` and
1408 ``--sec-node-tags`` options are similar as for the **startup** command
1409 and they influence the actual instances being rebooted.
1411 The ``--shutdown-timeout`` is used to specify how much time to wait
1412 before forcing the shutdown (xm destroy in xen, killing the kvm
1413 process, for kvm). By default two minutes are given to each instance
1416 The ``--force-multiple`` will skip the interactive confirmation in the
1417 case the more than one instance will be affected.
1419 See **ganeti**\(7) for a description of ``--submit`` and other common
1424 # gnt-instance reboot instance1.example.com
1425 # gnt-instance reboot --type=full instance1.example.com
1431 **console** [\--show-cmd] {*instance*}
1433 Connects to the console of the given instance. If the instance is not
1434 up, an error is returned. Use the ``--show-cmd`` option to display the
1435 command instead of executing it.
1437 For HVM instances, this will attempt to connect to the serial console
1438 of the instance. To connect to the virtualized "physical" console of a
1439 HVM instance, use a VNC client with the connection info from the
1442 For Xen/kvm instances, if the instance is paused, this attempts to
1443 unpause the instance after waiting a few seconds for the connection to
1444 the console to be made.
1448 # gnt-instance console instance1.example.com
1457 **replace-disks** [\--submit] [\--early-release] [\--ignore-ipolicy] {-p}
1458 [\--disks *idx*] {*instance*}
1460 **replace-disks** [\--submit] [\--early-release] [\--ignore-ipolicy] {-s}
1461 [\--disks *idx*] {*instance*}
1463 **replace-disks** [\--submit] [\--early-release] [\--ignore-ipolicy]
1464 {{-I\|\--iallocator} *name* \| {{-n|\--new-secondary} *node* } {*instance*}
1466 **replace-disks** [\--submit] [\--early-release] [\--ignore-ipolicy]
1467 {-a\|\--auto} {*instance*}
1469 This command is a generalized form for replacing disks. It is
1470 currently only valid for the mirrored (DRBD) disk template.
1472 The first form (when passing the ``-p`` option) will replace the disks
1473 on the primary, while the second form (when passing the ``-s`` option
1474 will replace the disks on the secondary node. For these two cases (as
1475 the node doesn't change), it is possible to only run the replace for a
1476 subset of the disks, using the option ``--disks`` which takes a list
1477 of comma-delimited disk indices (zero-based), e.g. 0,2 to replace only
1478 the first and third disks.
1480 The third form (when passing either the ``--iallocator`` or the
1481 ``--new-secondary`` option) is designed to change secondary node of the
1482 instance. Specifying ``--iallocator`` makes the new secondary be
1483 selected automatically by the specified allocator plugin (use ``.`` to
1484 indicate the default allocator), otherwise the new secondary node will
1485 be the one chosen manually via the ``--new-secondary`` option.
1487 Note that it is not possible to select an offline or drained node as a
1490 The fourth form (when using ``--auto``) will automatically determine
1491 which disks of an instance are faulty and replace them within the same
1492 node. The ``--auto`` option works only when an instance has only
1493 faulty disks on either the primary or secondary node; it doesn't work
1494 when both sides have faulty disks.
1496 The ``--early-release`` changes the code so that the old storage on
1497 secondary node(s) is removed early (before the resync is completed)
1498 and the internal Ganeti locks for the current (and new, if any)
1499 secondary node are also released, thus allowing more parallelism in
1500 the cluster operation. This should be used only when recovering from a
1501 disk failure on the current secondary (thus the old storage is already
1502 broken) or when the storage on the primary node is known to be fine
1503 (thus we won't need the old storage for potential recovery).
1505 The ``--ignore-ipolicy`` let the command ignore instance policy
1506 violations if replace-disks changes groups and the instance would
1507 violate the new groups instance policy.
1509 See **ganeti**\(7) for a description of ``--submit`` and other common
1515 **activate-disks** [\--submit] [\--ignore-size] [\--wait-for-sync] {*instance*}
1517 Activates the block devices of the given instance. If successful, the
1518 command will show the location and name of the block devices::
1520 node1.example.com:disk/0:/dev/drbd0
1521 node1.example.com:disk/1:/dev/drbd1
1524 In this example, *node1.example.com* is the name of the node on which
1525 the devices have been activated. The *disk/0* and *disk/1* are the
1526 Ganeti-names of the instance disks; how they are visible inside the
1527 instance is hypervisor-specific. */dev/drbd0* and */dev/drbd1* are the
1528 actual block devices as visible on the node.
1530 The ``--ignore-size`` option can be used to activate disks ignoring
1531 the currently configured size in Ganeti. This can be used in cases
1532 where the configuration has gotten out of sync with the real-world
1533 (e.g. after a partially-failed grow-disk operation or due to rounding
1534 in LVM devices). This should not be used in normal cases, but only
1535 when activate-disks fails without it.
1537 The ``--wait-for-sync`` option will ensure that the command returns only
1538 after the instance's disks are synchronised (mostly for DRBD); this can
1539 be useful to ensure consistency, as otherwise there are no commands that
1540 can wait until synchronisation is done. However when passing this
1541 option, the command will have additional output, making it harder to
1542 parse the disk information.
1544 Note that it is safe to run this command while the instance is already
1547 See **ganeti**\(7) for a description of ``--submit`` and other common
1553 **deactivate-disks** [-f] [\--submit] {*instance*}
1555 De-activates the block devices of the given instance. Note that if you
1556 run this command for an instance with a drbd disk template, while it
1557 is running, it will not be able to shutdown the block devices on the
1558 primary node, but it will shutdown the block devices on the secondary
1559 nodes, thus breaking the replication.
1561 The ``-f``/``--force`` option will skip checks that the instance is
1562 down; in case the hypervisor is confused and we can't talk to it,
1563 normally Ganeti will refuse to deactivate the disks, but with this
1564 option passed it will skip this check and directly try to deactivate
1565 the disks. This can still fail due to the instance actually running or
1568 See **ganeti**\(7) for a description of ``--submit`` and other common
1574 | **grow-disk** [\--no-wait-for-sync] [\--submit] [\--absolute]
1575 | {*instance*} {*disk*} {*amount*}
1577 Grows an instance's disk. This is only possible for instances having a
1578 plain, drbd, file, sharedfile, rbd or ext disk template. For the ext
1579 template to work, the ExtStorage provider should also support growing.
1580 This means having a ``grow`` script that actually grows the volume of
1581 the external shared storage.
1583 Note that this command only change the block device size; it will not
1584 grow the actual filesystems, partitions, etc. that live on that
1585 disk. Usually, you will need to:
1587 #. use **gnt-instance grow-disk**
1589 #. reboot the instance (later, at a convenient time)
1591 #. use a filesystem resizer, such as **ext2online**\(8) or
1592 **xfs\_growfs**\(8) to resize the filesystem, or use **fdisk**\(8) to
1593 change the partition table on the disk
1595 The *disk* argument is the index of the instance disk to grow. The
1596 *amount* argument is given as a number which can have a suffix (like the
1597 disk size in instance create); if the suffix is missing, the value will
1598 be interpreted as mebibytes.
1600 By default, the *amount* value represents the desired increase in the
1601 disk size (e.g. an amount of 1G will take a disk of size 3G to 4G). If
1602 the optional ``--absolute`` parameter is passed, then the *amount*
1603 argument doesn't represent the delta, but instead the desired final disk
1604 size (e.g. an amount of 8G will take a disk of size 4G to 8G).
1606 For instances with a drbd template, note that the disk grow operation
1607 might complete on one node but fail on the other; this will leave the
1608 instance with different-sized LVs on the two nodes, but this will not
1609 create problems (except for unused space).
1611 If you do not want gnt-instance to wait for the new disk region to be
1612 synced, use the ``--no-wait-for-sync`` option.
1614 See **ganeti**\(7) for a description of ``--submit`` and other common
1617 Example (increase the first disk for instance1 by 16GiB)::
1619 # gnt-instance grow-disk instance1.example.com 0 16g
1621 Example for increasing the disk size to a certain size::
1623 # gnt-instance grow-disk --absolute instance1.example.com 0 32g
1625 Also note that disk shrinking is not supported; use **gnt-backup
1626 export** and then **gnt-backup import** to reduce the disk size of an
1632 | **recreate-disks** [\--submit]
1633 | [{-n node1:[node2] \| {-I\|\--iallocator *name*}}]
1634 | [\--disk=*N*[:[size=*VAL*][,mode=*ro\|rw*]]] {*instance*}
1636 Recreates all or a subset of disks of the given instance.
1638 Note that this functionality should only be used for missing disks; if
1639 any of the given disks already exists, the operation will fail. While
1640 this is suboptimal, recreate-disks should hopefully not be needed in
1641 normal operation and as such the impact of this is low.
1643 If only a subset should be recreated, any number of ``disk`` options can
1644 be specified. It expects a disk index and an optional list of disk
1645 parameters to change. Only ``size`` and ``mode`` can be changed while
1646 recreating disks. To recreate all disks while changing parameters on
1647 a subset only, a ``--disk`` option must be given for every disk of the
1650 Optionally the instance's disks can be recreated on different
1651 nodes. This can be useful if, for example, the original nodes of the
1652 instance have gone down (and are marked offline), so we can't recreate
1653 on the same nodes. To do this, pass the new node(s) via ``-n`` option,
1654 with a syntax similar to the **add** command. The number of nodes
1655 passed must equal the number of nodes that the instance currently
1656 has. Note that changing nodes is only allowed when all disks are
1657 replaced, e.g. when no ``--disk`` option is passed.
1659 Another method of choosing which nodes to place the instance on is by
1660 using the specified iallocator, passing the ``--iallocator`` option.
1661 The primary and secondary nodes will be chosen by the specified
1662 iallocator plugin, or by the default allocator if ``.`` is specified.
1664 See **ganeti**\(7) for a description of ``--submit`` and other common
1673 | **failover** [-f] [\--ignore-consistency] [\--ignore-ipolicy]
1674 | [\--shutdown-timeout=*N*]
1675 | [{-n|\--target-node} *node* \| {-I|\--iallocator} *name*]
1676 | [\--submit] [\--cleanup]
1679 Failover will stop the instance (if running), change its primary node,
1680 and if it was originally running it will start it again (on the new
1681 primary). This works for instances with drbd template (in which case you
1682 can only fail to the secondary node) and for externally mirrored
1683 templates (sharedfile, blockdev, rbd and ext) (in which case you can
1684 fail to any other node).
1686 If the instance's disk template is of type sharedfile, blockdev, rbd or
1687 ext, then you can explicitly specify the target node (which can be any
1688 node) using the ``-n`` or ``--target-node`` option, or specify an
1689 iallocator plugin using the ``-I`` or ``--iallocator`` option. If you
1690 omit both, the default iallocator will be used to specify the target
1693 If the instance's disk template is of type drbd, the target node is
1694 automatically selected as the drbd's secondary node. Changing the
1695 secondary node is possible with a replace-disks operation.
1697 Normally the failover will check the consistency of the disks before
1698 failing over the instance. If you are trying to migrate instances off
1699 a dead node, this will fail. Use the ``--ignore-consistency`` option
1700 for this purpose. Note that this option can be dangerous as errors in
1701 shutting down the instance will be ignored, resulting in possibly
1702 having the instance running on two machines in parallel (on
1703 disconnected DRBD drives).
1705 The ``--shutdown-timeout`` is used to specify how much time to wait
1706 before forcing the shutdown (xm destroy in xen, killing the kvm
1707 process, for kvm). By default two minutes are given to each instance
1710 If ``--ignore-ipolicy`` is given any instance policy violations occuring
1711 during this operation are ignored.
1713 If the ``--cleanup`` option is passed, the operation changes from
1714 performin a failover to attempting recovery from a failed previous failover.
1715 In this mode, Ganeti checks if the instance runs on the correct node (and
1716 updates its configuration if not) and ensures the instances' disks
1717 are configured correctly.
1719 See **ganeti**\(7) for a description of ``--submit`` and other common
1724 # gnt-instance failover instance1.example.com
1726 For externally mirrored templates also ``-n`` is available::
1728 # gnt-instance failover -n node3.example.com instance1.example.com
1734 | **migrate** [-f] [\--allow-failover] [\--non-live]
1735 | [\--migration-mode=live\|non-live] [\--ignore-ipolicy]
1736 | [\--no-runtime-changes] [\--submit]
1737 | [{-n|\--target-node} *node* \| {-I|\--iallocator} *name*] {*instance*}
1739 | **migrate** [-f] \--cleanup [\--submit] {*instance*}
1741 Migrate will move the instance to its secondary node without shutdown.
1742 As with failover, it works for instances having the drbd disk template
1743 or an externally mirrored disk template type such as sharedfile,
1744 blockdev, rbd or ext.
1746 If the instance's disk template is of type sharedfile, blockdev, rbd or
1747 ext, then you can explicitly specify the target node (which can be any
1748 node) using the ``-n`` or ``--target-node`` option, or specify an
1749 iallocator plugin using the ``-I`` or ``--iallocator`` option. If you
1750 omit both, the default iallocator will be used to specify the target
1751 node. Alternatively, the default iallocator can be requested by
1752 specifying ``.`` as the name of the plugin.
1754 If the instance's disk template is of type drbd, the target node is
1755 automatically selected as the drbd's secondary node. Changing the
1756 secondary node is possible with a replace-disks operation.
1758 The migration command needs a perfectly healthy instance for drbd
1759 instances, as we rely on the dual-master capability of drbd8 and the
1760 disks of the instance are not allowed to be degraded.
1762 The ``--non-live`` and ``--migration-mode=non-live`` options will
1763 switch (for the hypervisors that support it) between a "fully live"
1764 (i.e. the interruption is as minimal as possible) migration and one in
1765 which the instance is frozen, its state saved and transported to the
1766 remote node, and then resumed there. This all depends on the
1767 hypervisor support for two different methods. In any case, it is not
1768 an error to pass this parameter (it will just be ignored if the
1769 hypervisor doesn't support it). The option ``--migration-mode=live``
1770 option will request a fully-live migration. The default, when neither
1771 option is passed, depends on the hypervisor parameters (and can be
1772 viewed with the **gnt-cluster info** command).
1774 If the ``--cleanup`` option is passed, the operation changes from
1775 migration to attempting recovery from a failed previous migration. In
1776 this mode, Ganeti checks if the instance runs on the correct node (and
1777 updates its configuration if not) and ensures the instances' disks
1778 are configured correctly. In this mode, the ``--non-live`` option is
1781 The option ``-f`` will skip the prompting for confirmation.
1783 If ``--allow-failover`` is specified it tries to fallback to failover if
1784 it already can determine that a migration won't work (e.g. if the
1785 instance is shut down). Please note that the fallback will not happen
1786 during execution. If a migration fails during execution it still fails.
1788 If ``--ignore-ipolicy`` is given any instance policy violations occuring
1789 during this operation are ignored.
1791 The ``--no-runtime-changes`` option forbids migrate to alter an
1792 instance's runtime before migrating it (eg. ballooning an instance
1793 down because the target node doesn't have enough available memory).
1795 If an instance has the backend parameter ``always_failover`` set to
1796 true, then the migration is automatically converted into a failover.
1798 See **ganeti**\(7) for a description of ``--submit`` and other common
1801 Example (and expected output)::
1803 # gnt-instance migrate instance1
1804 Instance instance1 will be migrated. Note that migration
1805 might impact the instance if anything goes wrong (e.g. due to bugs in
1806 the hypervisor). Continue?
1808 Migrating instance instance1.example.com
1809 * checking disk consistency between source and target
1810 * switching node node2.example.com to secondary mode
1811 * changing into standalone mode
1812 * changing disks into dual-master mode
1813 * wait until resync is done
1814 * preparing node2.example.com to accept the instance
1815 * migrating instance to node2.example.com
1816 * switching node node1.example.com to secondary mode
1817 * wait until resync is done
1818 * changing into standalone mode
1819 * changing disks into single-master mode
1820 * wait until resync is done
1828 | **move** [-f] [\--ignore-consistency]
1829 | [-n *node*] [\--shutdown-timeout=*N*] [\--submit] [\--ignore-ipolicy]
1832 Move will move the instance to an arbitrary node in the cluster. This
1833 works only for instances having a plain or file disk template.
1835 Note that since this operation is done via data copy, it will take a
1836 long time for big disks (similar to replace-disks for a drbd
1839 The ``--shutdown-timeout`` is used to specify how much time to wait
1840 before forcing the shutdown (e.g. ``xm destroy`` in XEN, killing the
1841 kvm process for KVM, etc.). By default two minutes are given to each
1844 The ``--ignore-consistency`` option will make Ganeti ignore any errors
1845 in trying to shutdown the instance on its node; useful if the
1846 hypervisor is broken and you want to recover the data.
1848 If ``--ignore-ipolicy`` is given any instance policy violations occuring
1849 during this operation are ignored.
1851 See **ganeti**\(7) for a description of ``--submit`` and other common
1856 # gnt-instance move -n node3.example.com instance1.example.com
1862 | **change-group** [\--submit]
1863 | [\--iallocator *NAME*] [\--to *GROUP*...] {*instance*}
1865 This command moves an instance to another node group. The move is
1866 calculated by an iallocator, either given on the command line or as a
1869 If no specific destination groups are specified using ``--to``, all
1870 groups except the one containing the instance are considered.
1872 See **ganeti**\(7) for a description of ``--submit`` and other common
1877 # gnt-instance change-group -I hail --to rack2 inst1.example.com
1886 **add-tags** [\--from *file*] {*instancename*} {*tag*...}
1888 Add tags to the given instance. If any of the tags contains invalid
1889 characters, the entire operation will abort.
1891 If the ``--from`` option is given, the list of tags will be extended
1892 with the contents of that file (each line becomes a tag). In this
1893 case, there is not need to pass tags on the command line (if you do,
1894 both sources will be used). A file name of ``-`` will be interpreted
1900 **list-tags** {*instancename*}
1902 List the tags of the given instance.
1907 **remove-tags** [\--from *file*] {*instancename*} {*tag*...}
1909 Remove tags from the given instance. If any of the tags are not
1910 existing on the node, the entire operation will abort.
1912 If the ``--from`` option is given, the list of tags to be removed will
1913 be extended with the contents of that file (each line becomes a tag).
1914 In this case, there is not need to pass tags on the command line (if
1915 you do, tags from both sources will be removed). A file name of ``-``
1916 will be interpreted as stdin.
1918 .. vim: set textwidth=72 :