1 gnt-instance(8) Ganeti | Version @GANETI_VERSION@
2 =================================================
7 gnt-instance - Ganeti instance administration
12 **gnt-instance** {command} [arguments...]
17 The **gnt-instance** command is used for instance administration in
23 Creation/removal/querying
24 ~~~~~~~~~~~~~~~~~~~~~~~~~
30 | {-t|\--disk-template {diskless | file \| plain \| drbd \| rbd}}
31 | {\--disk=*N*: {size=*VAL* \| adopt=*LV*}[,vg=*VG*][,metavg=*VG*][,mode=*ro\|rw*]
32 | \| {size=*VAL*,provider=*PROVIDER*}[,param=*value*... ][,mode=*ro\|rw*]
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, and optionally the access mode (read-only or
55 the default of read-write). The size is interpreted (when no unit is
56 given) in mebibytes. You can also use one of the suffixes *m*, *g* or
57 *t* to specify the exact the units used; these suffixes map to
58 mebibytes, gibibytes and tebibytes. For LVM and DRBD devices, the LVM
59 volume group can also be specified (via the ``vg`` key). For DRBD
60 devices, a different VG can be specified for the metadata device using
61 the ``metavg`` key. For ExtStorage devices, also the ``provider``
62 option is mandatory, to specify which ExtStorage provider to use.
64 When creating ExtStorage disks, also arbitrary parameters can be passed,
65 to the ExtStorage provider. Those parameters are passed as additional
66 comma separated options. Therefore, an ExtStorage disk provided by
67 provider ``pvdr1`` with parameters ``param1``, ``param2`` would be
68 passed as ``--disk 0:size=10G,provider=pvdr1,param1=val1,param2=val2``.
70 When using the ``adopt`` key in the disk definition, Ganeti will
71 reuse those volumes (instead of creating new ones) as the
72 instance's disks. Ganeti will rename these volumes to the standard
73 format, and (without installing the OS) will use them as-is for the
74 instance. This allows migrating instances from non-managed mode
75 (e.g. plain KVM with LVM) to being managed via Ganeti. Please note that
76 this works only for the \`plain' disk template (see below for
79 Alternatively, a single-disk instance can be created via the ``-s``
80 option which takes a single argument, the size of the disk. This is
81 similar to the Ganeti 1.2 version (but will only create one disk).
83 The minimum disk specification is therefore ``--disk 0:size=20G`` (or
84 ``-s 20G`` when using the ``-s`` option), and a three-disk instance
85 can be specified as ``--disk 0:size=20G --disk 1:size=4G --disk
88 The minimum information needed to specify an ExtStorage disk are the
89 ``size`` and the ``provider``. For example:
90 ``--disk 0:size=20G,provider=pvdr1``.
92 The ``--no-ip-check`` skips the checks that are done to see if the
93 instance's IP is not already alive (i.e. reachable from the master
96 The ``--no-name-check`` skips the check for the instance name via
97 the resolver (e.g. in DNS or /etc/hosts, depending on your setup).
98 Since the name check is used to compute the IP address, if you pass
99 this option you must also pass the ``--no-ip-check`` option.
101 If you don't want the instance to automatically start after
102 creation, this is possible via the ``--no-start`` option. This will
103 leave the instance down until a subsequent **gnt-instance start**
106 The NICs of the instances can be specified via the ``--net``
107 option. By default, one NIC is created for the instance, with a
108 random MAC, and set up according the the cluster level NIC
109 parameters. Each NIC can take these parameters (all optional):
112 either a value or 'generate' to generate a new unique MAC
115 specifies the IP address assigned to the instance from the Ganeti
116 side (this is not necessarily what the instance will use, but what
117 the node expects the instance to use). Note that if an IP in the
118 range of a network configured with **gnt-network**\(8) is used,
119 and the NIC is not already connected to it, this network has to be
120 passed in the **network** parameter if this NIC is meant to be
121 connected to the said network. ``--no-conflicts-check`` can be used
122 to override this check. The special value **pool** causes Ganeti to
123 select an IP from the the network the NIC is or will be connected to.
126 specifies the connection mode for this NIC: routed, bridged or
130 in bridged or openvswitch mode specifies the interface to attach
131 this NIC to, in routed mode it's intended to differentiate between
132 different routing tables/instance groups (but the meaning is
133 dependent on the network script, see **gnt-cluster**\(8) for more
134 details). Note that openvswitch support is also hypervisor
138 derives the mode and the link from the settings of the network
139 which is identified by its name. If the network option is chosen,
140 link and mode must not be specified. Note that the mode and link
141 depend on the network-to-nodegroup connection, thus allowing
142 different nodegroups to be connected to the same network in
146 Of these "mode" and "link" are NIC parameters, and inherit their
147 default at cluster level. Alternatively, if no network is desired for
148 the instance, you can prevent the default of one NIC with the
149 ``--no-nics`` option.
151 The ``-o (--os-type)`` option specifies the operating system to be
152 installed. The available operating systems can be listed with
153 **gnt-os list**. Passing ``--no-install`` will however skip the OS
154 installation, allowing a manual import if so desired. Note that the
155 no-installation mode will automatically disable the start-up of the
156 instance (without an OS, it most likely won't be able to start-up
159 The ``-B (--backend-parameters)`` option specifies the backend
160 parameters for the instance. If no such parameters are specified, the
161 values are inherited from the cluster. Possible parameters are:
164 the maximum memory size of the instance; as usual, suffixes can be
165 used to denote the unit, otherwise the value is taken in mebibytes
168 the minimum memory size of the instance; as usual, suffixes can be
169 used to denote the unit, otherwise the value is taken in mebibytes
172 the number of VCPUs to assign to the instance (if this value makes
173 sense for the hypervisor)
176 whether the instance is considered in the N+1 cluster checks
177 (enough redundancy in the cluster to survive a node failure)
180 ``True`` or ``False``, whether the instance must be failed over
181 (shut down and rebooted) always or it may be migrated (briefly
184 Note that before 2.6 Ganeti had a ``memory`` parameter, which was the
185 only value of memory an instance could have. With the
186 ``maxmem``/``minmem`` change Ganeti guarantees that at least the minimum
187 memory is always available for an instance, but allows more memory to be
188 used (up to the maximum memory) should it be free.
190 The ``-H (--hypervisor-parameters)`` option specified the hypervisor
191 to use for the instance (must be one of the enabled hypervisors on the
192 cluster) and optionally custom parameters for this instance. If not
193 other options are used (i.e. the invocation is just -H *NAME*) the
194 instance will inherit the cluster options. The defaults below show the
195 cluster defaults at cluster creation time.
197 The possible hypervisor options are as follows:
200 Valid for the Xen HVM and KVM hypervisors.
202 A string value denoting the boot order. This has different meaning
203 for the Xen HVM hypervisor and for the KVM one.
205 For Xen HVM, The boot order is a string of letters listing the boot
206 devices, with valid device letters being:
220 The default is not to set an HVM boot order, which is interpreted
223 For KVM the boot order is either "floppy", "cdrom", "disk" or
224 "network". Please note that older versions of KVM couldn't netboot
225 from virtio interfaces. This has been fixed in more recent versions
226 and is confirmed to work at least with qemu-kvm 0.11.1. Also note
227 that if you have set the ``kernel_path`` option, that will be used
228 for booting, and this setting will be silently ignored.
231 Valid for the Xen HVM and PVM hypervisors.
233 Relevant to non-pvops guest kernels, in which the disk device names
234 are given by the host. Allows one to specify 'xvd', which helps run
235 Red Hat based installers, driven by anaconda.
238 Valid for the KVM hypervisor.
240 The path to a floppy disk image to attach to the instance. This
241 is useful to install Windows operating systems on Virt/IO disks
242 because you can specify here the floppy for the drivers at
246 Valid for the Xen HVM and KVM hypervisors.
248 The path to a CDROM image to attach to the instance.
251 Valid for the KVM hypervisor.
253 The path to a second CDROM image to attach to the instance.
254 **NOTE**: This image can't be used to boot the system. To do that
255 you have to use the 'cdrom\_image\_path' option.
258 Valid for the Xen HVM and KVM hypervisors.
260 This parameter determines the way the network cards are presented
261 to the instance. The possible options are:
263 - rtl8139 (default for Xen HVM) (HVM & KVM)
264 - ne2k\_isa (HVM & KVM)
265 - ne2k\_pci (HVM & KVM)
271 - paravirtual (default for KVM) (HVM & KVM)
274 Valid for the Xen HVM hypervisor.
276 This parameter specifies the vif type of the nic configuration
277 of the instance. Unsetting the value leads to no type being specified
278 in the configuration. Note that this parameter only takes effect when
279 the 'nic_type' is not set. The possible options are:
285 Valid for the Xen HVM and KVM hypervisors.
287 This parameter determines the way the disks are presented to the
288 instance. The possible options are:
290 - ioemu [default] (HVM & KVM)
299 Valid for the KVM hypervisor.
301 This parameter determines the way the cdroms disks are presented
302 to the instance. The default behavior is to get the same value of
303 the earlier parameter (disk_type). The possible options are:
314 Valid for the Xen HVM and KVM hypervisors.
316 Specifies the address that the VNC listener for this instance
317 should bind to. Valid values are IPv4 addresses. Use the address
318 0.0.0.0 to bind to all available interfaces (this is the default)
319 or specify the address of one of the interfaces on the node to
320 restrict listening to that interface.
323 Valid for the KVM hypervisor.
325 A boolean option that controls whether the VNC connection is
329 Valid for the KVM hypervisor.
331 If ``vnc_tls`` is enabled, this options specifies the path to the
332 x509 certificate to use.
335 Valid for the KVM hypervisor.
338 Valid for the KVM hypervisor.
340 Specifies the address or interface on which the SPICE server will
341 listen. Valid values are:
343 - IPv4 addresses, including 0.0.0.0 and 127.0.0.1
344 - IPv6 addresses, including :: and ::1
345 - names of network interfaces
347 If a network interface is specified, the SPICE server will be bound
348 to one of the addresses of that interface.
351 Valid for the KVM hypervisor.
353 Specifies which version of the IP protocol should be used by the
356 It is mainly intended to be used for specifying what kind of IP
357 addresses should be used if a network interface with both IPv4 and
358 IPv6 addresses is specified via the ``spice_bind`` parameter. In
359 this case, if the ``spice_ip_version`` parameter is not used, the
360 default IP version of the cluster will be used.
362 spice\_password\_file
363 Valid for the KVM hypervisor.
365 Specifies a file containing the password that must be used when
366 connecting via the SPICE protocol. If the option is not specified,
367 passwordless connections are allowed.
369 spice\_image\_compression
370 Valid for the KVM hypervisor.
372 Configures the SPICE lossless image compression. Valid values are:
381 spice\_jpeg\_wan\_compression
382 Valid for the KVM hypervisor.
384 Configures how SPICE should use the jpeg algorithm for lossy image
385 compression on slow links. Valid values are:
391 spice\_zlib\_glz\_wan\_compression
392 Valid for the KVM hypervisor.
394 Configures how SPICE should use the zlib-glz algorithm for lossy image
395 compression on slow links. Valid values are:
401 spice\_streaming\_video
402 Valid for the KVM hypervisor.
404 Configures how SPICE should detect video streams. Valid values are:
410 spice\_playback\_compression
411 Valid for the KVM hypervisor.
413 Configures whether SPICE should compress audio streams or not.
416 Valid for the KVM hypervisor.
418 Specifies that the SPICE server must use TLS to encrypt all the
419 traffic with the client.
422 Valid for the KVM hypervisor.
424 Specifies a list of comma-separated ciphers that SPICE should use
425 for TLS connections. For the format, see man **cipher**\(1).
428 Valid for the KVM hypervisor.
430 Enables or disables passing mouse events via SPICE vdagent.
433 Valid for the KVM hypervisor.
435 This parameter determines the emulated cpu for the instance. If this
436 parameter is empty (which is the default configuration), it will not
439 Be aware of setting this parameter to ``"host"`` if you have nodes
440 with different CPUs from each other. Live migration may stop working
443 For more information please refer to the KVM manual.
446 Valid for the Xen HVM and KVM hypervisors.
448 A boolean option that specifies if the hypervisor should enable
449 ACPI support for this instance. By default, ACPI is disabled.
452 Valid for the Xen HVM and KVM hypervisors.
454 A boolean option that specifies if the hypervisor should enabled
455 PAE support for this instance. The default is false, disabling PAE
459 Valid for the Xen HVM and KVM hypervisors.
461 A boolean option that specifies if the instance should be started
462 with its clock set to the localtime of the machine (when true) or
463 to the UTC (When false). The default is false, which is useful for
464 Linux/Unix machines; for Windows OSes, it is recommended to enable
468 Valid for the Xen PVM and KVM hypervisors.
470 This option specifies the path (on the node) to the kernel to boot
471 the instance with. Xen PVM instances always require this, while for
472 KVM if this option is empty, it will cause the machine to load the
473 kernel from its disks (and the boot will be done accordingly to
477 Valid for the Xen PVM and KVM hypervisors.
479 This options specifies extra arguments to the kernel that will be
480 loaded. device. This is always used for Xen PVM, while for KVM it
481 is only used if the ``kernel_path`` option is also specified.
483 The default setting for this value is simply ``"ro"``, which
484 mounts the root disk (initially) in read-only one. For example,
485 setting this to single will cause the instance to start in
489 Valid for the Xen PVM and KVM hypervisors.
491 This option specifies the path (on the node) to the initrd to boot
492 the instance with. Xen PVM instances can use this always, while
493 for KVM if this option is only used if the ``kernel_path`` option
494 is also specified. You can pass here either an absolute filename
495 (the path to the initrd) if you want to use an initrd, or use the
496 format no\_initrd\_path for no initrd.
499 Valid for the Xen PVM and KVM hypervisors.
501 This options specifies the name of the root device. This is always
502 needed for Xen PVM, while for KVM it is only used if the
503 ``kernel_path`` option is also specified.
505 Please note, that if this setting is an empty string and the
506 hypervisor is Xen it will not be written to the Xen configuration
510 Valid for the KVM hypervisor.
512 This boolean option specifies whether to emulate a serial console
513 for the instance. Note that some versions of KVM have a bug that
514 will make an instance hang when configured to use the serial console
515 unless a connection is made to it within about 2 seconds of the
516 instance's startup. For such case it's recommended to disable this
517 option, which is enabled by default.
520 Valid for the KVM hypervisor.
522 This integer option specifies the speed of the serial console.
523 Common values are 9600, 19200, 38400, 57600 and 115200: choose the
524 one which works on your system. (The default is 38400 for historical
525 reasons, but newer versions of kvm/qemu work with 115200)
528 Valid for the KVM hypervisor.
530 The disk cache mode. It can be either default to not pass any
531 cache option to KVM, or one of the KVM cache modes: none (for
532 direct I/O), writethrough (to use the host cache but report
533 completion to the guest only when the host has committed the
534 changes to disk) or writeback (to use the host cache and report
535 completion as soon as the data is in the host cache). Note that
536 there are special considerations for the cache mode depending on
537 version of KVM used and disk type (always raw file under Ganeti),
538 please refer to the KVM documentation for more details.
541 Valid for the KVM hypervisor.
543 The security model for kvm. Currently one of *none*, *user* or
544 *pool*. Under *none*, the default, nothing is done and instances
545 are run as the Ganeti daemon user (normally root).
547 Under *user* kvm will drop privileges and become the user
548 specified by the security\_domain parameter.
550 Under *pool* a global cluster pool of users will be used, making
551 sure no two instances share the same user on the same node. (this
552 mode is not implemented yet)
555 Valid for the KVM hypervisor.
557 Under security model *user* the username to run the instance
558 under. It must be a valid username existing on the host.
560 Cannot be set under security model *none* or *pool*.
563 Valid for the KVM hypervisor.
565 If *enabled* the -enable-kvm flag is passed to kvm. If *disabled*
566 -disable-kvm is passed. If unset no flag is passed, and the
567 default running mode for your kvm binary will be used.
570 Valid for the KVM hypervisor.
572 This option passes the -mem-path argument to kvm with the path (on
573 the node) to the mount point of the hugetlbfs file system, along
574 with the -mem-prealloc argument too.
577 Valid for the KVM hypervisor.
579 This boolean option determines whether to run the KVM instance in a
582 If it is set to ``true``, an empty directory is created before
583 starting the instance and its path is passed via the -chroot flag
584 to kvm. The directory is removed when the instance is stopped.
586 It is set to ``false`` by default.
589 Valid for the KVM hypervisor.
591 The maximum amount of time (in ms) a KVM instance is allowed to be
592 frozen during a live migration, in order to copy dirty memory
593 pages. Default value is 30ms, but you may need to increase this
594 value for busy instances.
596 This option is only effective with kvm versions >= 87 and qemu-kvm
600 Valid for the Xen, KVM and LXC hypervisors.
602 The processes belonging to the given instance are only scheduled
603 on the specified CPUs.
605 The format of the mask can be given in three forms. First, the word
606 "all", which signifies the common case where all VCPUs can live on
607 any CPU, based on the hypervisor's decisions.
609 Second, a comma-separated list of CPU IDs or CPU ID ranges. The
610 ranges are defined by a lower and higher boundary, separated by a
611 dash, and the boundaries are inclusive. In this form, all VCPUs of
612 the instance will be mapped on the selected list of CPUs. Example:
613 ``0-2,5``, mapping all VCPUs (no matter how many) onto physical CPUs
616 The last form is used for explicit control of VCPU-CPU pinnings. In
617 this form, the list of VCPU mappings is given as a colon (:)
618 separated list, whose elements are the possible values for the
619 second or first form above. In this form, the number of elements in
620 the colon-separated list _must_ equal the number of VCPUs of the
627 # Map the entire instance to CPUs 0-2
628 gnt-instance modify -H cpu_mask=0-2 my-inst
630 # Map vCPU 0 to physical CPU 1 and vCPU 1 to CPU 3 (assuming 2 vCPUs)
631 gnt-instance modify -H cpu_mask=1:3 my-inst
633 # Pin vCPU 0 to CPUs 1 or 2, and vCPU 1 to any CPU
634 gnt-instance modify -H cpu_mask=1-2:all my-inst
636 # Pin vCPU 0 to any CPU, vCPU 1 to CPUs 1, 3, 4 or 5, and CPU 2 to
637 # CPU 0 (backslashes for escaping the comma)
638 gnt-instance modify -H cpu_mask=all:1\\,3-5:0 my-inst
640 # Pin entire VM to CPU 0
641 gnt-instance modify -H cpu_mask=0 my-inst
643 # Turn off CPU pinning (default setting)
644 gnt-instance modify -H cpu_mask=all my-inst
647 Valid for the Xen hypervisor.
649 Set the maximum amount of cpu usage by the VM. The value is a percentage
650 between 0 and (100 * number of VCPUs). Default cap is 0: unlimited.
653 Valid for the Xen hypervisor.
655 Set the cpu time ratio to be allocated to the VM. Valid values are
656 between 1 and 65535. Default weight is 256.
659 Valid for the KVM hypervisor.
661 This option specifies the usb mouse type to be used. It can be
662 "mouse" or "tablet". When using VNC it's recommended to set it to
666 Valid for the KVM hypervisor.
668 This option specifies the keyboard mapping to be used. It is only
669 needed when using the VNC console. For example: "fr" or "en-gb".
672 Valid for Xen PVM, Xen HVM and KVM hypervisors.
674 Normally if an instance reboots, the hypervisor will restart it. If
675 this option is set to ``exit``, the hypervisor will treat a reboot
676 as a shutdown instead.
678 It is set to ``reboot`` by default.
681 Valid for the KVM hypervisor.
683 Number of emulated CPU cores.
686 Valid for the KVM hypervisor.
688 Number of emulated CPU threads.
691 Valid for the KVM hypervisor.
693 Number of emulated CPU sockets.
696 Valid for the KVM hypervisor.
698 Comma separated list of emulated sounds cards, or "all" to enable
699 all the available ones.
702 Valid for the KVM hypervisor.
704 Comma separated list of usb devices. These can be emulated devices
705 or passthrough ones, and each one gets passed to kvm with its own
706 ``-usbdevice`` option. See the **qemu**\(1) manpage for the syntax
707 of the possible components.
710 Valid for the KVM hypervisor.
712 Emulated vga mode, passed the the kvm -vga option.
715 Valid for the KVM hypervisor.
717 Any other option to the KVM hypervisor, useful tweaking anything
718 that Ganeti doesn't support.
721 Valid for the KVM hypervisor.
723 Use in case an instance must be booted with an exact type of
724 machine version (due to e.g. outdated drivers). In case it's not set
725 the default version supported by your version of kvm is used.
728 Valid for the KVM hypervisor.
730 Path to the userspace KVM (or qemu) program.
732 The ``-O (--os-parameters)`` option allows customisation of the OS
733 parameters. The actual parameter names and values depends on the OS
734 being used, but the syntax is the same key=value. For example, setting
735 a hypothetical ``dhcp`` parameter to yes can be achieved by::
737 gnt-instance add -O dhcp=yes ...
739 The ``-I (--iallocator)`` option specifies the instance allocator plugin
740 to use (``.`` means the default allocator). If you pass in this option
741 the allocator will select nodes for this instance automatically, so you
742 don't need to pass them with the ``-n`` option. For more information
743 please refer to the instance allocator documentation.
745 The ``-t (--disk-template)`` options specifies the disk layout type
746 for the instance. The available choices are:
749 This creates an instance with no disks. Its useful for testing only
750 (or other special cases).
753 Disk devices will be regular files.
756 Disk devices will be regulare files on a shared directory.
759 Disk devices will be logical volumes.
762 Disk devices will be drbd (version 8.x) on top of lvm volumes.
765 Disk devices will be rbd volumes residing inside a RADOS cluster.
768 Disk devices will be adopted pre-existent block devices.
771 Disk devices will be provided by external shared storage,
772 through the ExtStorage Interface using ExtStorage providers.
774 The optional second value of the ``-n (--node)`` is used for the drbd
775 template type and specifies the remote node.
777 If you do not want gnt-instance to wait for the disk mirror to be
778 synced, use the ``--no-wait-for-sync`` option.
780 The ``--file-storage-dir`` specifies the relative path under the
781 cluster-wide file storage directory to store file-based disks. It is
782 useful for having different subdirectories for different
783 instances. The full path of the directory where the disk files are
784 stored will consist of cluster-wide file storage directory + optional
785 subdirectory + instance name. Example:
786 ``@RPL_FILE_STORAGE_DIR@/mysubdir/instance1.example.com``. This
787 option is only relevant for instances using the file storage backend.
789 The ``--file-driver`` specifies the driver to use for file-based
790 disks. Note that currently these drivers work with the xen hypervisor
791 only. This option is only relevant for instances using the file
792 storage backend. The available choices are:
795 Kernel loopback driver. This driver uses loopback devices to
796 access the filesystem within the file. However, running I/O
797 intensive applications in your instance using the loop driver
798 might result in slowdowns. Furthermore, if you use the loopback
799 driver consider increasing the maximum amount of loopback devices
800 (on most systems it's 8) using the max\_loop param.
803 The blktap driver (for Xen hypervisors). In order to be able to
804 use the blktap driver you should check if the 'blktapctrl' user
805 space disk agent is running (usually automatically started via
806 xend). This user-level disk I/O interface has the advantage of
807 better performance. Especially if you use a network file system
808 (e.g. NFS) to store your instances this is the recommended choice.
810 If ``--ignore-ipolicy`` is given any instance policy violations occuring
811 during this operation are ignored.
813 See **ganeti**\(7) for a description of ``--submit`` and other common
818 # gnt-instance add -t file --disk 0:size=30g -B maxmem=512 -o debian-etch \
819 -n node1.example.com --file-storage-dir=mysubdir instance1.example.com
820 # gnt-instance add -t plain --disk 0:size=30g -B maxmem=1024,minmem=512 \
821 -o debian-etch -n node1.example.com instance1.example.com
822 # gnt-instance add -t plain --disk 0:size=30g --disk 1:size=100g,vg=san \
823 -B maxmem=512 -o debian-etch -n node1.example.com instance1.example.com
824 # gnt-instance add -t drbd --disk 0:size=30g -B maxmem=512 -o debian-etch \
825 -n node1.example.com:node2.example.com instance2.example.com
826 # gnt-instance add -t rbd --disk 0:size=30g -B maxmem=512 -o debian-etch \
827 -n node1.example.com instance1.example.com
828 # gnt-instance add -t ext --disk 0:size=30g,provider=pvdr1 -B maxmem=512 \
829 -o debian-etch -n node1.example.com instance1.example.com
830 # gnt-instance add -t ext --disk 0:size=30g,provider=pvdr1,param1=val1 \
831 --disk 1:size=40g,provider=pvdr2,param2=val2,param3=val3 -B maxmem=512 \
832 -o debian-etch -n node1.example.com instance1.example.com
838 **batch-create** {instances\_file.json}
840 This command (similar to the Ganeti 1.2 **batcher** tool) submits
841 multiple instance creation jobs based on a definition file. The
842 instance configurations do not encompass all the possible options for
843 the **add** command, but only a subset.
845 The instance file should be a valid-formed JSON file, containing a
846 dictionary with instance name and instance parameters. The accepted
850 The size of the disks of the instance.
853 The disk template to use for the instance, the same as in the
857 A dictionary of backend parameters.
860 A dictionary with a single key (the hypervisor name), and as value
861 the hypervisor options. If not passed, the default hypervisor and
862 hypervisor options will be inherited.
865 Specifications for the one NIC that will be created for the
866 instance. 'bridge' is also accepted as a backwards compatible
870 List of NICs that will be created for the instance. Each entry
871 should be a dict, with mac, ip, mode and link as possible keys.
872 Please don't provide the "mac, ip, mode, link" parent keys if you
873 use this method for specifying NICs.
875 primary\_node, secondary\_node
876 The primary and optionally the secondary node to use for the
877 instance (in case an iallocator script is not used).
880 Instead of specifying the nodes, an iallocator script can be used
881 to automatically compute them.
884 whether to start the instance
887 Skip the check for already-in-use instance; see the description in
888 the **add** command for details.
891 Skip the name check for instances; see the description in the
892 **add** command for details.
894 file\_storage\_dir, file\_driver
895 Configuration for the file disk type, see the **add** command for
899 A simple definition for one instance can be (with most of the
900 parameters taken from the cluster defaults)::
906 "disk_size": ["25G"],
912 "disk_size": ["25G"],
913 "iallocator": "dumb",
914 "hypervisor": "xen-hvm",
915 "hvparams": {"acpi": true},
916 "backend": {"maxmem": 512, "minmem": 256}
920 The command will display the job id for each submitted instance, as
923 # gnt-instance batch-create instances.json
930 **remove** [\--ignore-failures] [\--shutdown-timeout=*N*] [\--submit]
931 [\--force] {*instance*}
933 Remove an instance. This will remove all data from the instance and
934 there is *no way back*. If you are not sure if you use an instance
935 again, use **shutdown** first and leave it in the shutdown state for a
938 The ``--ignore-failures`` option will cause the removal to proceed
939 even in the presence of errors during the removal of the instance
940 (e.g. during the shutdown or the disk removal). If this option is not
941 given, the command will stop at the first error.
943 The ``--shutdown-timeout`` is used to specify how much time to wait
944 before forcing the shutdown (e.g. ``xm destroy`` in Xen, killing the
945 kvm process for KVM, etc.). By default two minutes are given to each
948 The ``--force`` option is used to skip the interactive confirmation.
950 See **ganeti**\(7) for a description of ``--submit`` and other common
955 # gnt-instance remove instance1.example.com
962 | [\--no-headers] [\--separator=*SEPARATOR*] [\--units=*UNITS*] [-v]
963 | [{-o|\--output} *[+]FIELD,...*] [\--filter] [instance...]
965 Shows the currently configured instances with memory usage, disk
966 usage, the node they are running on, and their run status.
968 The ``--no-headers`` option will skip the initial header line. The
969 ``--separator`` option takes an argument which denotes what will be
970 used between the output fields. Both these options are to help
973 The units used to display the numeric values in the output varies,
974 depending on the options given. By default, the values will be
975 formatted in the most appropriate unit. If the ``--separator`` option
976 is given, then the values are shown in mebibytes to allow parsing by
977 scripts. In both cases, the ``--units`` option can be used to enforce
980 The ``-v`` option activates verbose mode, which changes the display of
981 special field states (see **ganeti**\(7)).
983 The ``-o (--output)`` option takes a comma-separated list of output
984 fields. The available fields and their meaning are:
986 @QUERY_FIELDS_INSTANCE@
988 If the value of the option starts with the character ``+``, the new
989 field(s) will be added to the default list. This allows one to quickly
990 see the default list plus a few other fields, instead of retyping the
991 entire list of fields.
993 There is a subtle grouping about the available output fields: all
994 fields except for ``oper_state``, ``oper_ram``, ``oper_vcpus`` and
995 ``status`` are configuration value and not run-time values. So if you
996 don't select any of the these fields, the query will be satisfied
997 instantly from the cluster configuration, without having to ask the
998 remote nodes for the data. This can be helpful for big clusters when
999 you only want some data and it makes sense to specify a reduced set of
1002 If exactly one argument is given and it appears to be a query filter
1003 (see **ganeti**\(7)), the query result is filtered accordingly. For
1004 ambiguous cases (e.g. a single field name as a filter) the ``--filter``
1005 (``-F``) option forces the argument to be treated as a filter (e.g.
1006 ``gnt-instance list -F admin_state``).
1008 The default output field list is: ``name``, ``os``, ``pnode``,
1009 ``admin_state``, ``oper_state``, ``oper_ram``.
1015 **list-fields** [field...]
1017 Lists available fields for instances.
1023 **info** [-s \| \--static] [\--roman] {\--all \| *instance*}
1025 Show detailed information about the given instance(s). This is
1026 different from **list** as it shows detailed data about the instance's
1027 disks (especially useful for the drbd disk template).
1029 If the option ``-s`` is used, only information available in the
1030 configuration file is returned, without querying nodes, making the
1033 Use the ``--all`` to get info about all instances, rather than
1034 explicitly passing the ones you're interested in.
1036 The ``--roman`` option can be used to cause envy among people who like
1037 ancient cultures, but are stuck with non-latin-friendly cluster
1038 virtualization technologies.
1044 | [{-H|\--hypervisor-parameters} *HYPERVISOR\_PARAMETERS*]
1045 | [{-B|\--backend-parameters} *BACKEND\_PARAMETERS*]
1046 | [{-m|\--runtime-memory} *SIZE*]
1047 | [\--net add*[:options]* \| \--net [*N*:]remove \| \--net *N:options*]
1048 | [\--disk add:size=*SIZE*[,vg=*VG*][,metavg=*VG*] \|
1049 | \--disk add:size=*SIZE*,provider=*PROVIDER*[,param=*value*... ] \|
1050 | \--disk [*N*:]remove \|
1051 | \--disk *N*:mode=*MODE*]
1052 | [{-t|\--disk-template} plain | {-t|\--disk-template} drbd -n *new_secondary*] [\--no-wait-for-sync]
1053 | [\--os-type=*OS* [\--force-variant]]
1054 | [{-O|\--os-parameters} *param*=*value*... ]
1055 | [\--offline \| \--online]
1057 | [\--ignore-ipolicy]
1060 Modifies the memory size, number of vcpus, ip address, MAC address
1061 and/or NIC parameters for an instance. It can also add and remove
1062 disks and NICs to/from the instance. Note that you need to give at
1063 least one of the arguments, otherwise the command complains.
1065 The ``-H (--hypervisor-parameters)``, ``-B (--backend-parameters)``
1066 and ``-O (--os-parameters)`` options specifies hypervisor, backend and
1067 OS parameter options in the form of name=value[,...]. For details
1068 which options can be specified, see the **add** command.
1070 The ``-t (--disk-template)`` option will change the disk template of
1071 the instance. Currently only conversions between the plain and drbd
1072 disk templates are supported, and the instance must be stopped before
1073 attempting the conversion. When changing from the plain to the drbd
1074 disk template, a new secondary node must be specified via the ``-n``
1075 option. The option ``--no-wait-for-sync`` can be used when converting
1076 to the ``drbd`` template in order to make the instance available for
1077 startup before DRBD has finished resyncing.
1079 The ``-m (--runtime-memory)`` option will change an instance's runtime
1080 memory to the given size (in MB if a different suffix is not specified),
1081 by ballooning it up or down to the new value.
1083 The ``--disk add:size=``*SIZE* option adds a disk to the instance. The
1084 optional ``vg=``*VG* option specifies an LVM volume group other than the
1085 default volume group to create the disk on. For DRBD disks, the
1086 ``metavg=``*VG* option specifies the volume group for the metadata
1087 device. When adding an ExtStorage disk the ``provider=``*PROVIDER*
1088 option is also mandatory and specifies the ExtStorage provider. Also,
1089 for ExtStorage disks arbitrary parameters can be passed as additional
1090 comma separated options, same as in the **add** command. ``--disk``
1091 *N*``:add,size=``**SIZE** can be used to add a disk at a specific index.
1092 The ``--disk remove`` option will remove the last disk of the instance.
1093 Use ``--disk `` *N*``:remove`` to remove a disk by its index. The
1094 ``--disk`` *N*``:mode=``*MODE* option will change the mode of the Nth
1095 disk of the instance between read-only (``ro``) and read-write (``rw``).
1097 The ``--net add:``*options* and ``--net`` *N*``:add,``*options* option
1098 will add a new network interface to the instance. The available options
1099 are the same as in the **add** command (``mac``, ``ip``, ``link``,
1100 ``mode``, ``network``). The ``--net remove`` will remove the last network
1101 interface of the instance (``--net`` *N*``:remove`` for a specific index),
1102 while the ``--net`` *N*``:``*options* option will change the parameters of
1103 the Nth instance network interface.
1105 The option ``-o (--os-type)`` will change the OS name for the instance
1106 (without reinstallation). In case an OS variant is specified that is
1107 not found, then by default the modification is refused, unless
1108 ``--force-variant`` is passed. An invalid OS will also be refused,
1109 unless the ``--force`` option is given.
1111 The ``--online`` and ``--offline`` options are used to transition an
1112 instance into and out of the ``offline`` state. An instance can be
1113 turned offline only if it was previously down. The ``--online`` option
1114 fails if the instance was not in the ``offline`` state, otherwise it
1115 changes instance's state to ``down``. These modifications take effect
1118 If ``--ignore-ipolicy`` is given any instance policy violations occuring
1119 during this operation are ignored.
1121 See **ganeti**\(7) for a description of ``--submit`` and other common
1124 Most of the changes take effect at the next restart. If the instance is
1125 running, there is no effect on the instance.
1130 | **reinstall** [{-o|\--os-type} *os-type*] [\--select-os] [-f *force*]
1131 | [\--force-multiple]
1132 | [\--instance \| \--node \| \--primary \| \--secondary \| \--all]
1133 | [{-O|\--os-parameters} *OS\_PARAMETERS*] [\--submit] {*instance*...}
1135 Reinstalls the operating system on the given instance(s). The
1136 instance(s) must be stopped when running this command. If the ``-o
1137 (--os-type)`` is specified, the operating system is changed.
1139 The ``--select-os`` option switches to an interactive OS reinstall.
1140 The user is prompted to select the OS template from the list of
1141 available OS templates. OS parameters can be overridden using ``-O
1142 (--os-parameters)`` (more documentation for this option under the
1145 Since this is a potentially dangerous command, the user will be
1146 required to confirm this action, unless the ``-f`` flag is passed.
1147 When multiple instances are selected (either by passing multiple
1148 arguments or by using the ``--node``, ``--primary``, ``--secondary``
1149 or ``--all`` options), the user must pass the ``--force-multiple``
1150 options to skip the interactive confirmation.
1152 See **ganeti**\(7) for a description of ``--submit`` and other common
1158 | **rename** [\--no-ip-check] [\--no-name-check] [\--submit]
1159 | {*instance*} {*new\_name*}
1161 Renames the given instance. The instance must be stopped when running
1162 this command. The requirements for the new name are the same as for
1163 adding an instance: the new name must be resolvable and the IP it
1164 resolves to must not be reachable (in order to prevent duplicate IPs
1165 the next time the instance is started). The IP test can be skipped if
1166 the ``--no-ip-check`` option is passed.
1168 Note that you can rename an instance to its same name, to force
1169 re-executing the os-specific rename script for that instance, if
1172 The ``--no-name-check`` skips the check for the new instance name via
1173 the resolver (e.g. in DNS or /etc/hosts, depending on your setup) and
1174 that the resolved name matches the provided name. Since the name check
1175 is used to compute the IP address, if you pass this option you must also
1176 pass the ``--no-ip-check`` option.
1178 See **ganeti**\(7) for a description of ``--submit`` and other common
1181 Starting/stopping/connecting to console
1182 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1188 | [\--force] [\--ignore-offline]
1189 | [\--force-multiple] [\--no-remember]
1190 | [\--instance \| \--node \| \--primary \| \--secondary \| \--all \|
1191 | \--tags \| \--node-tags \| \--pri-node-tags \| \--sec-node-tags]
1192 | [{-H|\--hypervisor-parameters} ``key=value...``]
1193 | [{-B|\--backend-parameters} ``key=value...``]
1194 | [\--submit] [\--paused]
1197 Starts one or more instances, depending on the following options. The
1198 four available modes are:
1201 will start the instances given as arguments (at least one argument
1202 required); this is the default selection
1205 will start the instances who have the given node as either primary
1209 will start all instances whose primary node is in the list of nodes
1210 passed as arguments (at least one node required)
1213 will start all instances whose secondary node is in the list of
1214 nodes passed as arguments (at least one node required)
1217 will start all instances in the cluster (no arguments accepted)
1220 will start all instances in the cluster with the tags given as
1224 will start all instances in the cluster on nodes with the tags
1228 will start all instances in the cluster on primary nodes with the
1229 tags given as arguments
1232 will start all instances in the cluster on secondary nodes with the
1233 tags given as arguments
1235 Note that although you can pass more than one selection option, the
1236 last one wins, so in order to guarantee the desired result, don't pass
1237 more than one such option.
1239 Use ``--force`` to start even if secondary disks are failing.
1240 ``--ignore-offline`` can be used to ignore offline primary nodes and
1241 mark the instance as started even if the primary is not available.
1243 The ``--force-multiple`` will skip the interactive confirmation in the
1244 case the more than one instance will be affected.
1246 The ``--no-remember`` option will perform the startup but not change
1247 the state of the instance in the configuration file (if it was stopped
1248 before, Ganeti will still think it needs to be stopped). This can be
1249 used for testing, or for a one shot-start where you don't want the
1250 watcher to restart the instance if it crashes.
1252 The ``-H (--hypervisor-parameters)`` and ``-B (--backend-parameters)``
1253 options specify temporary hypervisor and backend parameters that can
1254 be used to start an instance with modified parameters. They can be
1255 useful for quick testing without having to modify an instance back and
1258 # gnt-instance start -H kernel_args="single" instance1
1259 # gnt-instance start -B maxmem=2048 instance2
1262 The first form will start the instance instance1 in single-user mode,
1263 and the instance instance2 with 2GB of RAM (this time only, unless
1264 that is the actual instance memory size already). Note that the values
1265 override the instance parameters (and not extend them): an instance
1266 with "kernel\_args=ro" when started with -H kernel\_args=single will
1267 result in "single", not "ro single".
1269 The ``--paused`` option is only valid for Xen and kvm hypervisors. This
1270 pauses the instance at the start of bootup, awaiting ``gnt-instance
1271 console`` to unpause it, allowing the entire boot process to be
1272 monitored for debugging.
1274 See **ganeti**\(7) for a description of ``--submit`` and other common
1279 # gnt-instance start instance1.example.com
1280 # gnt-instance start --node node1.example.com node2.example.com
1281 # gnt-instance start --all
1289 | [\--force] [\--force-multiple] [\--ignore-offline] [\--no-remember]
1290 | [\--instance \| \--node \| \--primary \| \--secondary \| \--all \|
1291 | \--tags \| \--node-tags \| \--pri-node-tags \| \--sec-node-tags]
1295 Stops one or more instances. If the instance cannot be cleanly stopped
1296 during a hardcoded interval (currently 2 minutes), it will forcibly
1297 stop the instance (equivalent to switching off the power on a physical
1300 The ``--timeout`` is used to specify how much time to wait before
1301 forcing the shutdown (e.g. ``xm destroy`` in Xen, killing the kvm
1302 process for KVM, etc.). By default two minutes are given to each
1305 The ``--instance``, ``--node``, ``--primary``, ``--secondary``,
1306 ``--all``, ``--tags``, ``--node-tags``, ``--pri-node-tags`` and
1307 ``--sec-node-tags`` options are similar as for the **startup** command
1308 and they influence the actual instances being shutdown.
1310 ``--ignore-offline`` can be used to ignore offline primary nodes and
1311 force the instance to be marked as stopped. This option should be used
1312 with care as it can lead to an inconsistent cluster state.
1314 Use ``--force`` to be able to shutdown an instance even when it's marked
1315 as offline. This is useful is an offline instance ends up in the
1316 ``ERROR_up`` state, for example.
1318 The ``--no-remember`` option will perform the shutdown but not change
1319 the state of the instance in the configuration file (if it was running
1320 before, Ganeti will still thinks it needs to be running). This can be
1321 useful for a cluster-wide shutdown, where some instances are marked as
1322 up and some as down, and you don't want to change the running state:
1323 you just need to disable the watcher, shutdown all instances with
1324 ``--no-remember``, and when the watcher is activated again it will
1325 restore the correct runtime state for all instances.
1327 See **ganeti**\(7) for a description of ``--submit`` and other common
1332 # gnt-instance shutdown instance1.example.com
1333 # gnt-instance shutdown --all
1340 | [{-t|\--type} *REBOOT-TYPE*]
1341 | [\--ignore-secondaries]
1342 | [\--shutdown-timeout=*N*]
1343 | [\--force-multiple]
1344 | [\--instance \| \--node \| \--primary \| \--secondary \| \--all \|
1345 | \--tags \| \--node-tags \| \--pri-node-tags \| \--sec-node-tags]
1349 Reboots one or more instances. The type of reboot depends on the value
1350 of ``-t (--type)``. A soft reboot does a hypervisor reboot, a hard reboot
1351 does a instance stop, recreates the hypervisor config for the instance
1352 and starts the instance. A full reboot does the equivalent of
1353 **gnt-instance shutdown && gnt-instance startup**. The default is
1356 For the hard reboot the option ``--ignore-secondaries`` ignores errors
1357 for the secondary node while re-assembling the instance disks.
1359 The ``--instance``, ``--node``, ``--primary``, ``--secondary``,
1360 ``--all``, ``--tags``, ``--node-tags``, ``--pri-node-tags`` and
1361 ``--sec-node-tags`` options are similar as for the **startup** command
1362 and they influence the actual instances being rebooted.
1364 The ``--shutdown-timeout`` is used to specify how much time to wait
1365 before forcing the shutdown (xm destroy in xen, killing the kvm
1366 process, for kvm). By default two minutes are given to each instance
1369 The ``--force-multiple`` will skip the interactive confirmation in the
1370 case the more than one instance will be affected.
1372 See **ganeti**\(7) for a description of ``--submit`` and other common
1377 # gnt-instance reboot instance1.example.com
1378 # gnt-instance reboot --type=full instance1.example.com
1384 **console** [\--show-cmd] {*instance*}
1386 Connects to the console of the given instance. If the instance is not
1387 up, an error is returned. Use the ``--show-cmd`` option to display the
1388 command instead of executing it.
1390 For HVM instances, this will attempt to connect to the serial console
1391 of the instance. To connect to the virtualized "physical" console of a
1392 HVM instance, use a VNC client with the connection info from the
1395 For Xen/kvm instances, if the instance is paused, this attempts to
1396 unpause the instance after waiting a few seconds for the connection to
1397 the console to be made.
1401 # gnt-instance console instance1.example.com
1410 **replace-disks** [\--submit] [\--early-release] [\--ignore-ipolicy] {-p}
1411 [\--disks *idx*] {*instance*}
1413 **replace-disks** [\--submit] [\--early-release] [\--ignore-ipolicy] {-s}
1414 [\--disks *idx*] {*instance*}
1416 **replace-disks** [\--submit] [\--early-release] [\--ignore-ipolicy]
1417 {{-I\|\--iallocator} *name* \| {{-n|\--new-secondary} *node* } {*instance*}
1419 **replace-disks** [\--submit] [\--early-release] [\--ignore-ipolicy]
1420 {-a\|\--auto} {*instance*}
1422 This command is a generalized form for replacing disks. It is
1423 currently only valid for the mirrored (DRBD) disk template.
1425 The first form (when passing the ``-p`` option) will replace the disks
1426 on the primary, while the second form (when passing the ``-s`` option
1427 will replace the disks on the secondary node. For these two cases (as
1428 the node doesn't change), it is possible to only run the replace for a
1429 subset of the disks, using the option ``--disks`` which takes a list
1430 of comma-delimited disk indices (zero-based), e.g. 0,2 to replace only
1431 the first and third disks.
1433 The third form (when passing either the ``--iallocator`` or the
1434 ``--new-secondary`` option) is designed to change secondary node of the
1435 instance. Specifying ``--iallocator`` makes the new secondary be
1436 selected automatically by the specified allocator plugin (use ``.`` to
1437 indicate the default allocator), otherwise the new secondary node will
1438 be the one chosen manually via the ``--new-secondary`` option.
1440 Note that it is not possible to select an offline or drained node as a
1443 The fourth form (when using ``--auto``) will automatically determine
1444 which disks of an instance are faulty and replace them within the same
1445 node. The ``--auto`` option works only when an instance has only
1446 faulty disks on either the primary or secondary node; it doesn't work
1447 when both sides have faulty disks.
1449 The ``--early-release`` changes the code so that the old storage on
1450 secondary node(s) is removed early (before the resync is completed)
1451 and the internal Ganeti locks for the current (and new, if any)
1452 secondary node are also released, thus allowing more parallelism in
1453 the cluster operation. This should be used only when recovering from a
1454 disk failure on the current secondary (thus the old storage is already
1455 broken) or when the storage on the primary node is known to be fine
1456 (thus we won't need the old storage for potential recovery).
1458 The ``--ignore-ipolicy`` let the command ignore instance policy
1459 violations if replace-disks changes groups and the instance would
1460 violate the new groups instance policy.
1462 See **ganeti**\(7) for a description of ``--submit`` and other common
1468 **activate-disks** [\--submit] [\--ignore-size] [\--wait-for-sync] {*instance*}
1470 Activates the block devices of the given instance. If successful, the
1471 command will show the location and name of the block devices::
1473 node1.example.com:disk/0:/dev/drbd0
1474 node1.example.com:disk/1:/dev/drbd1
1477 In this example, *node1.example.com* is the name of the node on which
1478 the devices have been activated. The *disk/0* and *disk/1* are the
1479 Ganeti-names of the instance disks; how they are visible inside the
1480 instance is hypervisor-specific. */dev/drbd0* and */dev/drbd1* are the
1481 actual block devices as visible on the node.
1483 The ``--ignore-size`` option can be used to activate disks ignoring
1484 the currently configured size in Ganeti. This can be used in cases
1485 where the configuration has gotten out of sync with the real-world
1486 (e.g. after a partially-failed grow-disk operation or due to rounding
1487 in LVM devices). This should not be used in normal cases, but only
1488 when activate-disks fails without it.
1490 The ``--wait-for-sync`` option will ensure that the command returns only
1491 after the instance's disks are synchronised (mostly for DRBD); this can
1492 be useful to ensure consistency, as otherwise there are no commands that
1493 can wait until synchronisation is done. However when passing this
1494 option, the command will have additional output, making it harder to
1495 parse the disk information.
1497 Note that it is safe to run this command while the instance is already
1500 See **ganeti**\(7) for a description of ``--submit`` and other common
1506 **deactivate-disks** [-f] [\--submit] {*instance*}
1508 De-activates the block devices of the given instance. Note that if you
1509 run this command for an instance with a drbd disk template, while it
1510 is running, it will not be able to shutdown the block devices on the
1511 primary node, but it will shutdown the block devices on the secondary
1512 nodes, thus breaking the replication.
1514 The ``-f``/``--force`` option will skip checks that the instance is
1515 down; in case the hypervisor is confused and we can't talk to it,
1516 normally Ganeti will refuse to deactivate the disks, but with this
1517 option passed it will skip this check and directly try to deactivate
1518 the disks. This can still fail due to the instance actually running or
1521 See **ganeti**\(7) for a description of ``--submit`` and other common
1527 | **grow-disk** [\--no-wait-for-sync] [\--submit] [\--absolute]
1528 | {*instance*} {*disk*} {*amount*}
1530 Grows an instance's disk. This is only possible for instances having a
1531 plain, drbd, file, sharedfile, rbd or ext disk template. For the ext
1532 template to work, the ExtStorage provider should also support growing.
1533 This means having a ``grow`` script that actually grows the volume of
1534 the external shared storage.
1536 Note that this command only change the block device size; it will not
1537 grow the actual filesystems, partitions, etc. that live on that
1538 disk. Usually, you will need to:
1540 #. use **gnt-instance grow-disk**
1542 #. reboot the instance (later, at a convenient time)
1544 #. use a filesystem resizer, such as **ext2online**\(8) or
1545 **xfs\_growfs**\(8) to resize the filesystem, or use **fdisk**\(8) to
1546 change the partition table on the disk
1548 The *disk* argument is the index of the instance disk to grow. The
1549 *amount* argument is given as a number which can have a suffix (like the
1550 disk size in instance create); if the suffix is missing, the value will
1551 be interpreted as mebibytes.
1553 By default, the *amount* value represents the desired increase in the
1554 disk size (e.g. an amount of 1G will take a disk of size 3G to 4G). If
1555 the optional ``--absolute`` parameter is passed, then the *amount*
1556 argument doesn't represent the delta, but instead the desired final disk
1557 size (e.g. an amount of 8G will take a disk of size 4G to 8G).
1559 For instances with a drbd template, note that the disk grow operation
1560 might complete on one node but fail on the other; this will leave the
1561 instance with different-sized LVs on the two nodes, but this will not
1562 create problems (except for unused space).
1564 If you do not want gnt-instance to wait for the new disk region to be
1565 synced, use the ``--no-wait-for-sync`` option.
1567 See **ganeti**\(7) for a description of ``--submit`` and other common
1570 Example (increase the first disk for instance1 by 16GiB)::
1572 # gnt-instance grow-disk instance1.example.com 0 16g
1574 Example for increasing the disk size to a certain size::
1576 # gnt-instance grow-disk --absolute instance1.example.com 0 32g
1578 Also note that disk shrinking is not supported; use **gnt-backup
1579 export** and then **gnt-backup import** to reduce the disk size of an
1585 | **recreate-disks** [\--submit]
1586 | [{-n node1:[node2] \| {-I\|\--iallocator *name*}}]
1587 | [\--disk=*N*[:[size=*VAL*][,mode=*ro\|rw*]]] {*instance*}
1589 Recreates all or a subset of disks of the given instance.
1591 Note that this functionality should only be used for missing disks; if
1592 any of the given disks already exists, the operation will fail. While
1593 this is suboptimal, recreate-disks should hopefully not be needed in
1594 normal operation and as such the impact of this is low.
1596 If only a subset should be recreated, any number of ``disk`` options can
1597 be specified. It expects a disk index and an optional list of disk
1598 parameters to change. Only ``size`` and ``mode`` can be changed while
1599 recreating disks. To recreate all disks while changing parameters on
1600 a subset only, a ``--disk`` option must be given for every disk of the
1603 Optionally the instance's disks can be recreated on different
1604 nodes. This can be useful if, for example, the original nodes of the
1605 instance have gone down (and are marked offline), so we can't recreate
1606 on the same nodes. To do this, pass the new node(s) via ``-n`` option,
1607 with a syntax similar to the **add** command. The number of nodes
1608 passed must equal the number of nodes that the instance currently
1609 has. Note that changing nodes is only allowed when all disks are
1610 replaced, e.g. when no ``--disk`` option is passed.
1612 Another method of choosing which nodes to place the instance on is by
1613 using the specified iallocator, passing the ``--iallocator`` option.
1614 The primary and secondary nodes will be chosen by the specified
1615 iallocator plugin, or by the default allocator if ``.`` is specified.
1617 See **ganeti**\(7) for a description of ``--submit`` and other common
1626 | **failover** [-f] [\--ignore-consistency] [\--ignore-ipolicy]
1627 | [\--shutdown-timeout=*N*]
1628 | [{-n|\--target-node} *node* \| {-I|\--iallocator} *name*]
1632 Failover will stop the instance (if running), change its primary node,
1633 and if it was originally running it will start it again (on the new
1634 primary). This works for instances with drbd template (in which case you
1635 can only fail to the secondary node) and for externally mirrored
1636 templates (sharedfile, blockdev, rbd and ext) (in which case you can
1637 fail to any other node).
1639 If the instance's disk template is of type sharedfile, blockdev, rbd or
1640 ext, then you can explicitly specify the target node (which can be any
1641 node) using the ``-n`` or ``--target-node`` option, or specify an
1642 iallocator plugin using the ``-I`` or ``--iallocator`` option. If you
1643 omit both, the default iallocator will be used to specify the target
1646 If the instance's disk template is of type drbd, the target node is
1647 automatically selected as the drbd's secondary node. Changing the
1648 secondary node is possible with a replace-disks operation.
1650 Normally the failover will check the consistency of the disks before
1651 failing over the instance. If you are trying to migrate instances off
1652 a dead node, this will fail. Use the ``--ignore-consistency`` option
1653 for this purpose. Note that this option can be dangerous as errors in
1654 shutting down the instance will be ignored, resulting in possibly
1655 having the instance running on two machines in parallel (on
1656 disconnected DRBD drives).
1658 The ``--shutdown-timeout`` is used to specify how much time to wait
1659 before forcing the shutdown (xm destroy in xen, killing the kvm
1660 process, for kvm). By default two minutes are given to each instance
1663 If ``--ignore-ipolicy`` is given any instance policy violations occuring
1664 during this operation are ignored.
1666 See **ganeti**\(7) for a description of ``--submit`` and other common
1671 # gnt-instance failover instance1.example.com
1673 For externally mirrored templates also ``-n`` is available::
1675 # gnt-instance failover -n node3.example.com instance1.example.com
1681 | **migrate** [-f] [\--allow-failover] [\--non-live]
1682 | [\--migration-mode=live\|non-live] [\--ignore-ipolicy]
1683 | [\--no-runtime-changes] [\--submit]
1684 | [{-n|\--target-node} *node* \| {-I|\--iallocator} *name*] {*instance*}
1686 | **migrate** [-f] \--cleanup [\--submit] {*instance*}
1688 Migrate will move the instance to its secondary node without shutdown.
1689 As with failover, it works for instances having the drbd disk template
1690 or an externally mirrored disk template type such as sharedfile,
1691 blockdev, rbd or ext.
1693 If the instance's disk template is of type sharedfile, blockdev, rbd or
1694 ext, then you can explicitly specify the target node (which can be any
1695 node) using the ``-n`` or ``--target-node`` option, or specify an
1696 iallocator plugin using the ``-I`` or ``--iallocator`` option. If you
1697 omit both, the default iallocator will be used to specify the target
1698 node. Alternatively, the default iallocator can be requested by
1699 specifying ``.`` as the name of the plugin.
1701 If the instance's disk template is of type drbd, the target node is
1702 automatically selected as the drbd's secondary node. Changing the
1703 secondary node is possible with a replace-disks operation.
1705 The migration command needs a perfectly healthy instance for drbd
1706 instances, as we rely on the dual-master capability of drbd8 and the
1707 disks of the instance are not allowed to be degraded.
1709 The ``--non-live`` and ``--migration-mode=non-live`` options will
1710 switch (for the hypervisors that support it) between a "fully live"
1711 (i.e. the interruption is as minimal as possible) migration and one in
1712 which the instance is frozen, its state saved and transported to the
1713 remote node, and then resumed there. This all depends on the
1714 hypervisor support for two different methods. In any case, it is not
1715 an error to pass this parameter (it will just be ignored if the
1716 hypervisor doesn't support it). The option ``--migration-mode=live``
1717 option will request a fully-live migration. The default, when neither
1718 option is passed, depends on the hypervisor parameters (and can be
1719 viewed with the **gnt-cluster info** command).
1721 If the ``--cleanup`` option is passed, the operation changes from
1722 migration to attempting recovery from a failed previous migration. In
1723 this mode, Ganeti checks if the instance runs on the correct node (and
1724 updates its configuration if not) and ensures the instances' disks
1725 are configured correctly. In this mode, the ``--non-live`` option is
1728 The option ``-f`` will skip the prompting for confirmation.
1730 If ``--allow-failover`` is specified it tries to fallback to failover if
1731 it already can determine that a migration won't work (e.g. if the
1732 instance is shut down). Please note that the fallback will not happen
1733 during execution. If a migration fails during execution it still fails.
1735 If ``--ignore-ipolicy`` is given any instance policy violations occuring
1736 during this operation are ignored.
1738 The ``--no-runtime-changes`` option forbids migrate to alter an
1739 instance's runtime before migrating it (eg. ballooning an instance
1740 down because the target node doesn't have enough available memory).
1742 If an instance has the backend parameter ``always_failover`` set to
1743 true, then the migration is automatically converted into a failover.
1745 See **ganeti**\(7) for a description of ``--submit`` and other common
1748 Example (and expected output)::
1750 # gnt-instance migrate instance1
1751 Instance instance1 will be migrated. Note that migration
1752 might impact the instance if anything goes wrong (e.g. due to bugs in
1753 the hypervisor). Continue?
1755 Migrating instance instance1.example.com
1756 * checking disk consistency between source and target
1757 * switching node node2.example.com to secondary mode
1758 * changing into standalone mode
1759 * changing disks into dual-master mode
1760 * wait until resync is done
1761 * preparing node2.example.com to accept the instance
1762 * migrating instance to node2.example.com
1763 * switching node node1.example.com to secondary mode
1764 * wait until resync is done
1765 * changing into standalone mode
1766 * changing disks into single-master mode
1767 * wait until resync is done
1775 | **move** [-f] [\--ignore-consistency]
1776 | [-n *node*] [\--shutdown-timeout=*N*] [\--submit] [\--ignore-ipolicy]
1779 Move will move the instance to an arbitrary node in the cluster. This
1780 works only for instances having a plain or file disk template.
1782 Note that since this operation is done via data copy, it will take a
1783 long time for big disks (similar to replace-disks for a drbd
1786 The ``--shutdown-timeout`` is used to specify how much time to wait
1787 before forcing the shutdown (e.g. ``xm destroy`` in XEN, killing the
1788 kvm process for KVM, etc.). By default two minutes are given to each
1791 The ``--ignore-consistency`` option will make Ganeti ignore any errors
1792 in trying to shutdown the instance on its node; useful if the
1793 hypervisor is broken and you want to recover the data.
1795 If ``--ignore-ipolicy`` is given any instance policy violations occuring
1796 during this operation are ignored.
1798 See **ganeti**\(7) for a description of ``--submit`` and other common
1803 # gnt-instance move -n node3.example.com instance1.example.com
1809 | **change-group** [\--submit]
1810 | [\--iallocator *NAME*] [\--to *GROUP*...] {*instance*}
1812 This command moves an instance to another node group. The move is
1813 calculated by an iallocator, either given on the command line or as a
1816 If no specific destination groups are specified using ``--to``, all
1817 groups except the one containing the instance are considered.
1819 See **ganeti**\(7) for a description of ``--submit`` and other common
1824 # gnt-instance change-group -I hail --to rack2 inst1.example.com
1833 **add-tags** [\--from *file*] {*instancename*} {*tag*...}
1835 Add tags to the given instance. If any of the tags contains invalid
1836 characters, the entire operation will abort.
1838 If the ``--from`` option is given, the list of tags will be extended
1839 with the contents of that file (each line becomes a tag). In this
1840 case, there is not need to pass tags on the command line (if you do,
1841 both sources will be used). A file name of ``-`` will be interpreted
1847 **list-tags** {*instancename*}
1849 List the tags of the given instance.
1854 **remove-tags** [\--from *file*] {*instancename*} {*tag*...}
1856 Remove tags from the given instance. If any of the tags are not
1857 existing on the node, the entire operation will abort.
1859 If the ``--from`` option is given, the list of tags to be removed will
1860 be extended with the contents of that file (each line becomes a tag).
1861 In this case, there is not need to pass tags on the command line (if
1862 you do, tags from both sources will be removed). A file name of ``-``
1863 will be interpreted as stdin.
1865 .. vim: set textwidth=72 :