1 gnt-instance(8) Ganeti | Version @GANETI_VERSION@
2 =================================================
7 gnt-instance - Ganeti instance administration
12 **gnt-instance** {command} [arguments...]
17 The **gnt-instance** command is used for instance administration in
23 Creation/removal/querying
24 ~~~~~~~~~~~~~~~~~~~~~~~~~
30 | {-t|\--disk-template {diskless | file \| plain \| drbd \| rbd}}
31 | {\--disk=*N*: {size=*VAL* \| adopt=*LV*}[,options...]
32 | \| {size=*VAL*,provider=*PROVIDER*}[,param=*value*... ][,options...]
33 | \| {-s|\--os-size} *SIZE*}
34 | [\--no-ip-check] [\--no-name-check] [\--no-conflicts-check]
35 | [\--no-start] [\--no-install]
36 | [\--net=*N* [:options...] \| \--no-nics]
37 | [{-B|\--backend-parameters} *BEPARAMS*]
38 | [{-H|\--hypervisor-parameters} *HYPERVISOR* [: option=*value*... ]]
39 | [{-O|\--os-parameters} *param*=*value*... ]
40 | [\--file-storage-dir *dir\_path*] [\--file-driver {loop \| blktap \| blktap2}]
41 | {{-n|\--node} *node[:secondary-node]* \| {-I|\--iallocator} *name*}
42 | {{-o|\--os-type} *os-type*}
47 Creates a new instance on the specified host. The *instance* argument
48 must be in DNS, but depending on the bridge/routing setup, need not be
49 in the same network as the nodes in the cluster.
51 The ``disk`` option specifies the parameters for the disks of the
52 instance. The numbering of disks starts at zero, and at least one disk
53 needs to be passed. For each disk, either the size or the adoption
54 source needs to be given. The size is interpreted (when no unit is
55 given) in mebibytes. You can also use one of the suffixes *m*, *g* or
56 *t* to specify the exact the units used; these suffixes map to
57 mebibytes, gibibytes and tebibytes. Each disk can also take these
58 parameters (all optional):
61 The access mode. Either ``ro`` (read-only) or the default ``rw``
65 this option specifies a name for the disk, which can be used as a disk
66 identifier. An instance can not have two disks with the same name.
69 The LVM volume group. This works only for LVM and DRBD devices.
72 This options specifies a different VG for the metadata device. This
73 works only for DRBD devices
75 When creating ExtStorage disks, also arbitrary parameters can be passed,
76 to the ExtStorage provider. Those parameters are passed as additional
77 comma separated options. Therefore, an ExtStorage disk provided by
78 provider ``pvdr1`` with parameters ``param1``, ``param2`` would be
79 passed as ``--disk 0:size=10G,provider=pvdr1,param1=val1,param2=val2``.
81 When using the ``adopt`` key in the disk definition, Ganeti will
82 reuse those volumes (instead of creating new ones) as the
83 instance's disks. Ganeti will rename these volumes to the standard
84 format, and (without installing the OS) will use them as-is for the
85 instance. This allows migrating instances from non-managed mode
86 (e.g. plain KVM with LVM) to being managed via Ganeti. Please note that
87 this works only for the \`plain' disk template (see below for
90 Alternatively, a single-disk instance can be created via the ``-s``
91 option which takes a single argument, the size of the disk. This is
92 similar to the Ganeti 1.2 version (but will only create one disk).
94 The minimum disk specification is therefore ``--disk 0:size=20G`` (or
95 ``-s 20G`` when using the ``-s`` option), and a three-disk instance
96 can be specified as ``--disk 0:size=20G --disk 1:size=4G --disk
99 The minimum information needed to specify an ExtStorage disk are the
100 ``size`` and the ``provider``. For example:
101 ``--disk 0:size=20G,provider=pvdr1``.
103 The ``--no-ip-check`` skips the checks that are done to see if the
104 instance's IP is not already alive (i.e. reachable from the master
107 The ``--no-name-check`` skips the check for the instance name via
108 the resolver (e.g. in DNS or /etc/hosts, depending on your setup).
109 Since the name check is used to compute the IP address, if you pass
110 this option you must also pass the ``--no-ip-check`` option.
112 If you don't want the instance to automatically start after
113 creation, this is possible via the ``--no-start`` option. This will
114 leave the instance down until a subsequent **gnt-instance start**
117 The NICs of the instances can be specified via the ``--net``
118 option. By default, one NIC is created for the instance, with a
119 random MAC, and set up according the the cluster level NIC
120 parameters. Each NIC can take these parameters (all optional):
123 either a value or 'generate' to generate a new unique MAC
126 specifies the IP address assigned to the instance from the Ganeti
127 side (this is not necessarily what the instance will use, but what
128 the node expects the instance to use). Note that if an IP in the
129 range of a network configured with **gnt-network**\(8) is used,
130 and the NIC is not already connected to it, this network has to be
131 passed in the **network** parameter if this NIC is meant to be
132 connected to the said network. ``--no-conflicts-check`` can be used
133 to override this check. The special value **pool** causes Ganeti to
134 select an IP from the the network the NIC is or will be connected to.
135 One can pick an externally reserved IP of a network along with
136 ``--no-conflict-check``. Note that this IP cannot be assigned to
137 any other instance until it gets released.
140 specifies the connection mode for this NIC: routed, bridged or
144 in bridged or openvswitch mode specifies the interface to attach
145 this NIC to, in routed mode it's intended to differentiate between
146 different routing tables/instance groups (but the meaning is
147 dependent on the network script, see **gnt-cluster**\(8) for more
148 details). Note that openvswitch support is also hypervisor
152 derives the mode and the link from the settings of the network
153 which is identified by its name. If the network option is chosen,
154 link and mode must not be specified. Note that the mode and link
155 depend on the network-to-nodegroup connection, thus allowing
156 different nodegroups to be connected to the same network in
160 this option specifies a name for the NIC, which can be used as a NIC
161 identifier. An instance can not have two NICs with the same name.
164 Of these "mode" and "link" are NIC parameters, and inherit their
165 default at cluster level. Alternatively, if no network is desired for
166 the instance, you can prevent the default of one NIC with the
167 ``--no-nics`` option.
169 The ``-o (--os-type)`` option specifies the operating system to be
170 installed. The available operating systems can be listed with
171 **gnt-os list**. Passing ``--no-install`` will however skip the OS
172 installation, allowing a manual import if so desired. Note that the
173 no-installation mode will automatically disable the start-up of the
174 instance (without an OS, it most likely won't be able to start-up
177 The ``-B (--backend-parameters)`` option specifies the backend
178 parameters for the instance. If no such parameters are specified, the
179 values are inherited from the cluster. Possible parameters are:
182 the maximum memory size of the instance; as usual, suffixes can be
183 used to denote the unit, otherwise the value is taken in mebibytes
186 the minimum memory size of the instance; as usual, suffixes can be
187 used to denote the unit, otherwise the value is taken in mebibytes
190 the number of VCPUs to assign to the instance (if this value makes
191 sense for the hypervisor)
194 whether the instance is considered in the N+1 cluster checks
195 (enough redundancy in the cluster to survive a node failure)
198 ``True`` or ``False``, whether the instance must be failed over
199 (shut down and rebooted) always or it may be migrated (briefly
202 Note that before 2.6 Ganeti had a ``memory`` parameter, which was the
203 only value of memory an instance could have. With the
204 ``maxmem``/``minmem`` change Ganeti guarantees that at least the minimum
205 memory is always available for an instance, but allows more memory to be
206 used (up to the maximum memory) should it be free.
208 The ``-H (--hypervisor-parameters)`` option specified the hypervisor
209 to use for the instance (must be one of the enabled hypervisors on the
210 cluster) and optionally custom parameters for this instance. If not
211 other options are used (i.e. the invocation is just -H *NAME*) the
212 instance will inherit the cluster options. The defaults below show the
213 cluster defaults at cluster creation time.
215 The possible hypervisor options are as follows:
218 Valid for the Xen HVM and KVM hypervisors.
220 A string value denoting the boot order. This has different meaning
221 for the Xen HVM hypervisor and for the KVM one.
223 For Xen HVM, The boot order is a string of letters listing the boot
224 devices, with valid device letters being:
238 The default is not to set an HVM boot order, which is interpreted
241 For KVM the boot order is either "floppy", "cdrom", "disk" or
242 "network". Please note that older versions of KVM couldn't netboot
243 from virtio interfaces. This has been fixed in more recent versions
244 and is confirmed to work at least with qemu-kvm 0.11.1. Also note
245 that if you have set the ``kernel_path`` option, that will be used
246 for booting, and this setting will be silently ignored.
249 Valid for the Xen HVM and PVM hypervisors.
251 Relevant to non-pvops guest kernels, in which the disk device names
252 are given by the host. Allows one to specify 'xvd', which helps run
253 Red Hat based installers, driven by anaconda.
256 Valid for the KVM hypervisor.
258 The path to a floppy disk image to attach to the instance. This
259 is useful to install Windows operating systems on Virt/IO disks
260 because you can specify here the floppy for the drivers at
264 Valid for the Xen HVM and KVM hypervisors.
266 The path to a CDROM image to attach to the instance.
269 Valid for the KVM hypervisor.
271 The path to a second CDROM image to attach to the instance.
272 **NOTE**: This image can't be used to boot the system. To do that
273 you have to use the 'cdrom\_image\_path' option.
276 Valid for the Xen HVM and KVM hypervisors.
278 This parameter determines the way the network cards are presented
279 to the instance. The possible options are:
281 - rtl8139 (default for Xen HVM) (HVM & KVM)
282 - ne2k\_isa (HVM & KVM)
283 - ne2k\_pci (HVM & KVM)
289 - paravirtual (default for KVM) (HVM & KVM)
292 Valid for the Xen HVM hypervisor.
294 This parameter specifies the vif type of the nic configuration
295 of the instance. Unsetting the value leads to no type being specified
296 in the configuration. Note that this parameter only takes effect when
297 the 'nic_type' is not set. The possible options are:
303 Valid for the Xen HVM and KVM hypervisors.
305 This parameter determines the way the disks are presented to the
306 instance. The possible options are:
308 - ioemu [default] (HVM & KVM)
317 Valid for the KVM hypervisor.
319 This parameter determines the way the cdroms disks are presented
320 to the instance. The default behavior is to get the same value of
321 the earlier parameter (disk_type). The possible options are:
332 Valid for the Xen HVM and KVM hypervisors.
334 Specifies the address that the VNC listener for this instance
335 should bind to. Valid values are IPv4 addresses. Use the address
336 0.0.0.0 to bind to all available interfaces (this is the default)
337 or specify the address of one of the interfaces on the node to
338 restrict listening to that interface.
341 Valid for the KVM hypervisor.
343 A boolean option that controls whether the VNC connection is
347 Valid for the KVM hypervisor.
349 If ``vnc_tls`` is enabled, this options specifies the path to the
350 x509 certificate to use.
353 Valid for the KVM hypervisor.
356 Valid for the KVM hypervisor.
358 Specifies the address or interface on which the SPICE server will
359 listen. Valid values are:
361 - IPv4 addresses, including 0.0.0.0 and 127.0.0.1
362 - IPv6 addresses, including :: and ::1
363 - names of network interfaces
365 If a network interface is specified, the SPICE server will be bound
366 to one of the addresses of that interface.
369 Valid for the KVM hypervisor.
371 Specifies which version of the IP protocol should be used by the
374 It is mainly intended to be used for specifying what kind of IP
375 addresses should be used if a network interface with both IPv4 and
376 IPv6 addresses is specified via the ``spice_bind`` parameter. In
377 this case, if the ``spice_ip_version`` parameter is not used, the
378 default IP version of the cluster will be used.
380 spice\_password\_file
381 Valid for the KVM hypervisor.
383 Specifies a file containing the password that must be used when
384 connecting via the SPICE protocol. If the option is not specified,
385 passwordless connections are allowed.
387 spice\_image\_compression
388 Valid for the KVM hypervisor.
390 Configures the SPICE lossless image compression. Valid values are:
399 spice\_jpeg\_wan\_compression
400 Valid for the KVM hypervisor.
402 Configures how SPICE should use the jpeg algorithm for lossy image
403 compression on slow links. Valid values are:
409 spice\_zlib\_glz\_wan\_compression
410 Valid for the KVM hypervisor.
412 Configures how SPICE should use the zlib-glz algorithm for lossy image
413 compression on slow links. Valid values are:
419 spice\_streaming\_video
420 Valid for the KVM hypervisor.
422 Configures how SPICE should detect video streams. Valid values are:
428 spice\_playback\_compression
429 Valid for the KVM hypervisor.
431 Configures whether SPICE should compress audio streams or not.
434 Valid for the KVM hypervisor.
436 Specifies that the SPICE server must use TLS to encrypt all the
437 traffic with the client.
440 Valid for the KVM hypervisor.
442 Specifies a list of comma-separated ciphers that SPICE should use
443 for TLS connections. For the format, see man **cipher**\(1).
446 Valid for the KVM hypervisor.
448 Enables or disables passing mouse events via SPICE vdagent.
451 Valid for the KVM hypervisor.
453 This parameter determines the emulated cpu for the instance. If this
454 parameter is empty (which is the default configuration), it will not
457 Be aware of setting this parameter to ``"host"`` if you have nodes
458 with different CPUs from each other. Live migration may stop working
461 For more information please refer to the KVM manual.
464 Valid for the Xen HVM and KVM hypervisors.
466 A boolean option that specifies if the hypervisor should enable
467 ACPI support for this instance. By default, ACPI is disabled.
470 Valid for the Xen HVM and KVM hypervisors.
472 A boolean option that specifies if the hypervisor should enable
473 PAE support for this instance. The default is false, disabling PAE
477 Valid for the Xen HVM hypervisor.
479 A boolean option that specifies if the hypervisor should enable
480 viridian (Hyper-V) for this instance. The default is false,
481 disabling viridian support.
484 Valid for the Xen HVM and KVM hypervisors.
486 A boolean option that specifies if the instance should be started
487 with its clock set to the localtime of the machine (when true) or
488 to the UTC (When false). The default is false, which is useful for
489 Linux/Unix machines; for Windows OSes, it is recommended to enable
493 Valid for the Xen PVM and KVM hypervisors.
495 This option specifies the path (on the node) to the kernel to boot
496 the instance with. Xen PVM instances always require this, while for
497 KVM if this option is empty, it will cause the machine to load the
498 kernel from its disks (and the boot will be done accordingly to
502 Valid for the Xen PVM and KVM hypervisors.
504 This options specifies extra arguments to the kernel that will be
505 loaded. device. This is always used for Xen PVM, while for KVM it
506 is only used if the ``kernel_path`` option is also specified.
508 The default setting for this value is simply ``"ro"``, which
509 mounts the root disk (initially) in read-only one. For example,
510 setting this to single will cause the instance to start in
514 Valid for the Xen PVM and KVM hypervisors.
516 This option specifies the path (on the node) to the initrd to boot
517 the instance with. Xen PVM instances can use this always, while
518 for KVM if this option is only used if the ``kernel_path`` option
519 is also specified. You can pass here either an absolute filename
520 (the path to the initrd) if you want to use an initrd, or use the
521 format no\_initrd\_path for no initrd.
524 Valid for the Xen PVM and KVM hypervisors.
526 This options specifies the name of the root device. This is always
527 needed for Xen PVM, while for KVM it is only used if the
528 ``kernel_path`` option is also specified.
530 Please note, that if this setting is an empty string and the
531 hypervisor is Xen it will not be written to the Xen configuration
535 Valid for the KVM hypervisor.
537 This boolean option specifies whether to emulate a serial console
538 for the instance. Note that some versions of KVM have a bug that
539 will make an instance hang when configured to use the serial console
540 unless a connection is made to it within about 2 seconds of the
541 instance's startup. For such case it's recommended to disable this
542 option, which is enabled by default.
545 Valid for the KVM hypervisor.
547 This integer option specifies the speed of the serial console.
548 Common values are 9600, 19200, 38400, 57600 and 115200: choose the
549 one which works on your system. (The default is 38400 for historical
550 reasons, but newer versions of kvm/qemu work with 115200)
553 Valid for the KVM hypervisor.
555 The disk cache mode. It can be either default to not pass any
556 cache option to KVM, or one of the KVM cache modes: none (for
557 direct I/O), writethrough (to use the host cache but report
558 completion to the guest only when the host has committed the
559 changes to disk) or writeback (to use the host cache and report
560 completion as soon as the data is in the host cache). Note that
561 there are special considerations for the cache mode depending on
562 version of KVM used and disk type (always raw file under Ganeti),
563 please refer to the KVM documentation for more details.
566 Valid for the KVM hypervisor.
568 The security model for kvm. Currently one of *none*, *user* or
569 *pool*. Under *none*, the default, nothing is done and instances
570 are run as the Ganeti daemon user (normally root).
572 Under *user* kvm will drop privileges and become the user
573 specified by the security\_domain parameter.
575 Under *pool* a global cluster pool of users will be used, making
576 sure no two instances share the same user on the same node. (this
577 mode is not implemented yet)
580 Valid for the KVM hypervisor.
582 Under security model *user* the username to run the instance
583 under. It must be a valid username existing on the host.
585 Cannot be set under security model *none* or *pool*.
588 Valid for the KVM hypervisor.
590 If *enabled* the -enable-kvm flag is passed to kvm. If *disabled*
591 -disable-kvm is passed. If unset no flag is passed, and the
592 default running mode for your kvm binary will be used.
595 Valid for the KVM hypervisor.
597 This option passes the -mem-path argument to kvm with the path (on
598 the node) to the mount point of the hugetlbfs file system, along
599 with the -mem-prealloc argument too.
602 Valid for the KVM hypervisor.
604 This boolean option determines whether to run the KVM instance in a
607 If it is set to ``true``, an empty directory is created before
608 starting the instance and its path is passed via the -chroot flag
609 to kvm. The directory is removed when the instance is stopped.
611 It is set to ``false`` by default.
614 Valid for the KVM hypervisor.
616 The maximum amount of time (in ms) a KVM instance is allowed to be
617 frozen during a live migration, in order to copy dirty memory
618 pages. Default value is 30ms, but you may need to increase this
619 value for busy instances.
621 This option is only effective with kvm versions >= 87 and qemu-kvm
625 Valid for the Xen, KVM and LXC hypervisors.
627 The processes belonging to the given instance are only scheduled
628 on the specified CPUs.
630 The format of the mask can be given in three forms. First, the word
631 "all", which signifies the common case where all VCPUs can live on
632 any CPU, based on the hypervisor's decisions.
634 Second, a comma-separated list of CPU IDs or CPU ID ranges. The
635 ranges are defined by a lower and higher boundary, separated by a
636 dash, and the boundaries are inclusive. In this form, all VCPUs of
637 the instance will be mapped on the selected list of CPUs. Example:
638 ``0-2,5``, mapping all VCPUs (no matter how many) onto physical CPUs
641 The last form is used for explicit control of VCPU-CPU pinnings. In
642 this form, the list of VCPU mappings is given as a colon (:)
643 separated list, whose elements are the possible values for the
644 second or first form above. In this form, the number of elements in
645 the colon-separated list _must_ equal the number of VCPUs of the
652 # Map the entire instance to CPUs 0-2
653 gnt-instance modify -H cpu_mask=0-2 my-inst
655 # Map vCPU 0 to physical CPU 1 and vCPU 1 to CPU 3 (assuming 2 vCPUs)
656 gnt-instance modify -H cpu_mask=1:3 my-inst
658 # Pin vCPU 0 to CPUs 1 or 2, and vCPU 1 to any CPU
659 gnt-instance modify -H cpu_mask=1-2:all my-inst
661 # Pin vCPU 0 to any CPU, vCPU 1 to CPUs 1, 3, 4 or 5, and CPU 2 to
662 # CPU 0 (backslashes for escaping the comma)
663 gnt-instance modify -H cpu_mask=all:1\\,3-5:0 my-inst
665 # Pin entire VM to CPU 0
666 gnt-instance modify -H cpu_mask=0 my-inst
668 # Turn off CPU pinning (default setting)
669 gnt-instance modify -H cpu_mask=all my-inst
672 Valid for the Xen hypervisor.
674 Set the maximum amount of cpu usage by the VM. The value is a percentage
675 between 0 and (100 * number of VCPUs). Default cap is 0: unlimited.
678 Valid for the Xen hypervisor.
680 Set the cpu time ratio to be allocated to the VM. Valid values are
681 between 1 and 65535. Default weight is 256.
684 Valid for the KVM hypervisor.
686 This option specifies the usb mouse type to be used. It can be
687 "mouse" or "tablet". When using VNC it's recommended to set it to
691 Valid for the KVM hypervisor.
693 This option specifies the keyboard mapping to be used. It is only
694 needed when using the VNC console. For example: "fr" or "en-gb".
697 Valid for Xen PVM, Xen HVM and KVM hypervisors.
699 Normally if an instance reboots, the hypervisor will restart it. If
700 this option is set to ``exit``, the hypervisor will treat a reboot
701 as a shutdown instead.
703 It is set to ``reboot`` by default.
706 Valid for the KVM hypervisor.
708 Number of emulated CPU cores.
711 Valid for the KVM hypervisor.
713 Number of emulated CPU threads.
716 Valid for the KVM hypervisor.
718 Number of emulated CPU sockets.
721 Valid for the KVM hypervisor.
723 Comma separated list of emulated sounds cards, or "all" to enable
724 all the available ones.
727 Valid for the KVM hypervisor.
729 Comma separated list of usb devices. These can be emulated devices
730 or passthrough ones, and each one gets passed to kvm with its own
731 ``-usbdevice`` option. See the **qemu**\(1) manpage for the syntax
732 of the possible components.
735 Valid for the KVM hypervisor.
737 Emulated vga mode, passed the the kvm -vga option.
740 Valid for the KVM hypervisor.
742 Any other option to the KVM hypervisor, useful tweaking anything
743 that Ganeti doesn't support. Note that values set with this
744 parameter are split on a space character and currently don't support
748 Valid for the KVM hypervisor.
750 Use in case an instance must be booted with an exact type of
751 machine version (due to e.g. outdated drivers). In case it's not set
752 the default version supported by your version of kvm is used.
755 Valid for the KVM hypervisor.
757 Path to the userspace KVM (or qemu) program.
760 Valid for the KVM hypervisor.
762 This boolean option determines whether the tap devices used by the
763 KVM paravirtual nics (virtio-net) will get created with VNET_HDR
764 (IFF_VNET_HDR) support.
766 If set to false, it effectively disables offloading on the virio-net
767 interfaces, which prevents host kernel tainting and log flooding,
768 when dealing with broken or malicious virtio-net drivers.
770 It is set to ``true`` by default.
772 The ``-O (--os-parameters)`` option allows customisation of the OS
773 parameters. The actual parameter names and values depends on the OS
774 being used, but the syntax is the same key=value. For example, setting
775 a hypothetical ``dhcp`` parameter to yes can be achieved by::
777 gnt-instance add -O dhcp=yes ...
779 The ``-I (--iallocator)`` option specifies the instance allocator plugin
780 to use (``.`` means the default allocator). If you pass in this option
781 the allocator will select nodes for this instance automatically, so you
782 don't need to pass them with the ``-n`` option. For more information
783 please refer to the instance allocator documentation.
785 The ``-t (--disk-template)`` options specifies the disk layout type
786 for the instance. The available choices are:
789 This creates an instance with no disks. Its useful for testing only
790 (or other special cases).
793 Disk devices will be regular files.
796 Disk devices will be regulare files on a shared directory.
799 Disk devices will be logical volumes.
802 Disk devices will be drbd (version 8.x) on top of lvm volumes.
805 Disk devices will be rbd volumes residing inside a RADOS cluster.
808 Disk devices will be adopted pre-existent block devices.
811 Disk devices will be provided by external shared storage,
812 through the ExtStorage Interface using ExtStorage providers.
814 The optional second value of the ``-n (--node)`` is used for the drbd
815 template type and specifies the remote node.
817 If you do not want gnt-instance to wait for the disk mirror to be
818 synced, use the ``--no-wait-for-sync`` option.
820 The ``--file-storage-dir`` specifies the relative path under the
821 cluster-wide file storage directory to store file-based disks. It is
822 useful for having different subdirectories for different
823 instances. The full path of the directory where the disk files are
824 stored will consist of cluster-wide file storage directory + optional
825 subdirectory + instance name. Example:
826 ``@RPL_FILE_STORAGE_DIR@/mysubdir/instance1.example.com``. This
827 option is only relevant for instances using the file storage backend.
829 The ``--file-driver`` specifies the driver to use for file-based
830 disks. Note that currently these drivers work with the xen hypervisor
831 only. This option is only relevant for instances using the file
832 storage backend. The available choices are:
835 Kernel loopback driver. This driver uses loopback devices to
836 access the filesystem within the file. However, running I/O
837 intensive applications in your instance using the loop driver
838 might result in slowdowns. Furthermore, if you use the loopback
839 driver consider increasing the maximum amount of loopback devices
840 (on most systems it's 8) using the max\_loop param.
843 The blktap driver (for Xen hypervisors). In order to be able to
844 use the blktap driver you should check if the 'blktapctrl' user
845 space disk agent is running (usually automatically started via
846 xend). This user-level disk I/O interface has the advantage of
847 better performance. Especially if you use a network file system
848 (e.g. NFS) to store your instances this is the recommended choice.
851 Analogous to the blktap driver, but used by newer versions of Xen.
853 If ``--ignore-ipolicy`` is given any instance policy violations occuring
854 during this operation are ignored.
856 See **ganeti**\(7) for a description of ``--submit`` and other common
861 # gnt-instance add -t file --disk 0:size=30g -B maxmem=512 -o debian-etch \
862 -n node1.example.com --file-storage-dir=mysubdir instance1.example.com
863 # gnt-instance add -t plain --disk 0:size=30g -B maxmem=1024,minmem=512 \
864 -o debian-etch -n node1.example.com instance1.example.com
865 # gnt-instance add -t plain --disk 0:size=30g --disk 1:size=100g,vg=san \
866 -B maxmem=512 -o debian-etch -n node1.example.com instance1.example.com
867 # gnt-instance add -t drbd --disk 0:size=30g -B maxmem=512 -o debian-etch \
868 -n node1.example.com:node2.example.com instance2.example.com
869 # gnt-instance add -t rbd --disk 0:size=30g -B maxmem=512 -o debian-etch \
870 -n node1.example.com instance1.example.com
871 # gnt-instance add -t ext --disk 0:size=30g,provider=pvdr1 -B maxmem=512 \
872 -o debian-etch -n node1.example.com instance1.example.com
873 # gnt-instance add -t ext --disk 0:size=30g,provider=pvdr1,param1=val1 \
874 --disk 1:size=40g,provider=pvdr2,param2=val2,param3=val3 -B maxmem=512 \
875 -o debian-etch -n node1.example.com instance1.example.com
882 | [{-I|\--iallocator} *instance allocator*]
883 | {instances\_file.json}
885 This command (similar to the Ganeti 1.2 **batcher** tool) submits
886 multiple instance creation jobs based on a definition file. This
887 file can contain all options which are valid when adding an instance
888 with the exception of the ``iallocator`` field. The IAllocator is,
889 for optimization purposes, only allowed to be set for the whole batch
890 operation using the ``--iallocator`` parameter.
892 The instance file must be a valid-formed JSON file, containing an
893 array of dictionaries with instance creation parameters. All parameters
894 (except ``iallocator``) which are valid for the instance creation
895 OP code are allowed. The most important ones are:
898 The FQDN of the new instance.
901 The disk template to use for the instance, the same as in the
905 Array of disk specifications. Each entry describes one disk as a
906 dictionary of disk parameters.
909 A dictionary of backend parameters.
912 The hypervisor for the instance.
915 A dictionary with the hypervisor options. If not passed, the default
916 hypervisor options will be inherited.
919 List of NICs that will be created for the instance. Each entry
920 should be a dict, with mac, ip, mode and link as possible keys.
921 Please don't provide the "mac, ip, mode, link" parent keys if you
922 use this method for specifying NICs.
925 The primary and optionally the secondary node to use for the
926 instance (in case an iallocator script is not used). If those
927 parameters are given, they have to be given consistently for all
928 instances in the batch operation.
931 whether to start the instance
934 Skip the check for already-in-use instance; see the description in
935 the **add** command for details.
938 Skip the name check for instances; see the description in the
939 **add** command for details.
941 file\_storage\_dir, file\_driver
942 Configuration for the file disk type, see the **add** command for
946 A simple definition for one instance can be (with most of the
947 parameters taken from the cluster defaults)::
952 "instance_name": "instance1.example.com",
953 "disk_template": "drbd",
954 "os_type": "debootstrap",
955 "disks": [{"size":"1024"}],
957 "hypervisor": "xen-pvm"
961 "instance_name": "instance2.example.com",
962 "disk_template": "drbd",
963 "os_type": "debootstrap",
964 "disks": [{"size":"4096", "mode": "rw", "vg": "xenvg"}],
966 "hypervisor": "xen-hvm",
967 "hvparams": {"acpi": true},
968 "beparams": {"maxmem": 512, "minmem": 256}
972 The command will display the job id for each submitted instance, as
975 # gnt-instance batch-create instances.json
976 Submitted jobs 37, 38
981 **remove** [\--ignore-failures] [\--shutdown-timeout=*N*] [\--submit]
982 [\--force] {*instance*}
984 Remove an instance. This will remove all data from the instance and
985 there is *no way back*. If you are not sure if you use an instance
986 again, use **shutdown** first and leave it in the shutdown state for a
989 The ``--ignore-failures`` option will cause the removal to proceed
990 even in the presence of errors during the removal of the instance
991 (e.g. during the shutdown or the disk removal). If this option is not
992 given, the command will stop at the first error.
994 The ``--shutdown-timeout`` is used to specify how much time to wait
995 before forcing the shutdown (e.g. ``xm destroy`` in Xen, killing the
996 kvm process for KVM, etc.). By default two minutes are given to each
999 The ``--force`` option is used to skip the interactive confirmation.
1001 See **ganeti**\(7) for a description of ``--submit`` and other common
1006 # gnt-instance remove instance1.example.com
1013 | [\--no-headers] [\--separator=*SEPARATOR*] [\--units=*UNITS*] [-v]
1014 | [{-o|\--output} *[+]FIELD,...*] [\--filter] [instance...]
1016 Shows the currently configured instances with memory usage, disk
1017 usage, the node they are running on, and their run status.
1019 The ``--no-headers`` option will skip the initial header line. The
1020 ``--separator`` option takes an argument which denotes what will be
1021 used between the output fields. Both these options are to help
1024 The units used to display the numeric values in the output varies,
1025 depending on the options given. By default, the values will be
1026 formatted in the most appropriate unit. If the ``--separator`` option
1027 is given, then the values are shown in mebibytes to allow parsing by
1028 scripts. In both cases, the ``--units`` option can be used to enforce
1029 a given output unit.
1031 The ``-v`` option activates verbose mode, which changes the display of
1032 special field states (see **ganeti**\(7)).
1034 The ``-o (--output)`` option takes a comma-separated list of output
1035 fields. The available fields and their meaning are:
1037 @QUERY_FIELDS_INSTANCE@
1039 If the value of the option starts with the character ``+``, the new
1040 field(s) will be added to the default list. This allows one to quickly
1041 see the default list plus a few other fields, instead of retyping the
1042 entire list of fields.
1044 There is a subtle grouping about the available output fields: all
1045 fields except for ``oper_state``, ``oper_ram``, ``oper_vcpus`` and
1046 ``status`` are configuration value and not run-time values. So if you
1047 don't select any of the these fields, the query will be satisfied
1048 instantly from the cluster configuration, without having to ask the
1049 remote nodes for the data. This can be helpful for big clusters when
1050 you only want some data and it makes sense to specify a reduced set of
1053 If exactly one argument is given and it appears to be a query filter
1054 (see **ganeti**\(7)), the query result is filtered accordingly. For
1055 ambiguous cases (e.g. a single field name as a filter) the ``--filter``
1056 (``-F``) option forces the argument to be treated as a filter (e.g.
1057 ``gnt-instance list -F admin_state``).
1059 The default output field list is: ``name``, ``os``, ``pnode``,
1060 ``admin_state``, ``oper_state``, ``oper_ram``.
1066 **list-fields** [field...]
1068 Lists available fields for instances.
1074 **info** [-s \| \--static] [\--roman] {\--all \| *instance*}
1076 Show detailed information about the given instance(s). This is
1077 different from **list** as it shows detailed data about the instance's
1078 disks (especially useful for the drbd disk template).
1080 If the option ``-s`` is used, only information available in the
1081 configuration file is returned, without querying nodes, making the
1084 Use the ``--all`` to get info about all instances, rather than
1085 explicitly passing the ones you're interested in.
1087 The ``--roman`` option can be used to cause envy among people who like
1088 ancient cultures, but are stuck with non-latin-friendly cluster
1089 virtualization technologies.
1095 | [{-H|\--hypervisor-parameters} *HYPERVISOR\_PARAMETERS*]
1096 | [{-B|\--backend-parameters} *BACKEND\_PARAMETERS*]
1097 | [{-m|\--runtime-memory} *SIZE*]
1098 | [\--net add[:options...] \|
1099 | \--net [*N*:]add[,options...] \|
1100 | \--net [*ID*:]remove \|
1101 | \--net *ID*:modify[,options...]]
1102 | [\--disk add:size=*SIZE*[,options...] \|
1103 | \--disk *N*:add,size=*SIZE*[,options...] \|
1104 | \--disk *N*:add,size=*SIZE*,provider=*PROVIDER*[,options...][,param=*value*... ] \|
1105 | \--disk *ID*:modify[,options...]
1106 | \--disk [*ID*:]remove]
1107 | [{-t|\--disk-template} plain | {-t|\--disk-template} drbd -n *new_secondary*] [\--no-wait-for-sync]
1108 | [\--new-primary=*node*]
1109 | [\--os-type=*OS* [\--force-variant]]
1110 | [{-O|\--os-parameters} *param*=*value*... ]
1111 | [\--offline \| \--online]
1113 | [\--ignore-ipolicy]
1117 Modifies the memory size, number of vcpus, ip address, MAC address
1118 and/or NIC parameters for an instance. It can also add and remove
1119 disks and NICs to/from the instance. Note that you need to give at
1120 least one of the arguments, otherwise the command complains.
1122 The ``-H (--hypervisor-parameters)``, ``-B (--backend-parameters)``
1123 and ``-O (--os-parameters)`` options specifies hypervisor, backend and
1124 OS parameter options in the form of name=value[,...]. For details
1125 which options can be specified, see the **add** command.
1127 The ``-t (--disk-template)`` option will change the disk template of
1128 the instance. Currently only conversions between the plain and drbd
1129 disk templates are supported, and the instance must be stopped before
1130 attempting the conversion. When changing from the plain to the drbd
1131 disk template, a new secondary node must be specified via the ``-n``
1132 option. The option ``--no-wait-for-sync`` can be used when converting
1133 to the ``drbd`` template in order to make the instance available for
1134 startup before DRBD has finished resyncing.
1136 The ``-m (--runtime-memory)`` option will change an instance's runtime
1137 memory to the given size (in MB if a different suffix is not specified),
1138 by ballooning it up or down to the new value.
1140 The ``--disk add:size=*SIZE*,[options..]`` option adds a disk to the
1141 instance, and ``--disk *N*:add:size=*SIZE*,[options..]`` will add a disk
1142 to the the instance at a specific index. The available options are the
1143 same as in the **add** command(``mode``, ``name``, ``vg``, ``metavg``).
1144 When adding an ExtStorage disk the ``provider=*PROVIDER*`` option is
1145 also mandatory and specifies the ExtStorage provider. Also, for
1146 ExtStorage disks arbitrary parameters can be passed as additional comma
1147 separated options, same as in the **add** command. -The ``--disk remove``
1148 option will remove the last disk of the instance. Use
1149 ``--disk `` *ID*``:remove`` to remove a disk by its identifier. *ID*
1150 can be the index of the disk, the disks's name or the disks's UUID. The
1151 ``--disk *ID*:modify[,options...]`` wil change the options of the disk.
1152 Available options are:
1155 The access mode. Either ``ro`` (read-only) or the default ``rw`` (read-write).
1158 this option specifies a name for the disk, which can be used as a disk
1159 identifier. An instance can not have two disks with the same name.
1161 The ``--net *N*:add[,options..]`` will add a new network interface to
1162 the instance. The available options are the same as in the **add**
1163 command (``mac``, ``ip``, ``link``, ``mode``, ``network``). The
1164 ``--net *ID*,remove`` will remove the intances' NIC with *ID* identifier,
1165 which can be the index of the NIC, the NIC's name or the NIC's UUID.
1166 The ``--net *ID*:modify[,options..]`` option will change the parameters of
1167 the instance network interface with the *ID* identifier.
1169 The option ``-o (--os-type)`` will change the OS name for the instance
1170 (without reinstallation). In case an OS variant is specified that is
1171 not found, then by default the modification is refused, unless
1172 ``--force-variant`` is passed. An invalid OS will also be refused,
1173 unless the ``--force`` option is given.
1175 The option ``--new-primary`` will set the new primary node of an instance
1176 assuming the disks have already been moved manually. Unless the ``--force``
1177 option is given, it is verified that the instance is no longer running
1178 on its current primary node.
1180 The ``--online`` and ``--offline`` options are used to transition an
1181 instance into and out of the ``offline`` state. An instance can be
1182 turned offline only if it was previously down. The ``--online`` option
1183 fails if the instance was not in the ``offline`` state, otherwise it
1184 changes instance's state to ``down``. These modifications take effect
1187 If ``--ignore-ipolicy`` is given any instance policy violations occuring
1188 during this operation are ignored.
1190 If ``--hotplug`` is given any disk and NIC modifications will take
1191 effect without the need of actual reboot. Please note that this feature
1192 is currently supported only for KVM hypervisor and there are some
1193 restrictions: a) KVM versions >= 1.0 support it b) instances with chroot
1194 or uid pool security model do not support disk hotplug c) RBD disks with
1195 userspace access mode can not be hotplugged (yet) d) if hotplug fails
1196 (for any reason) a warning is printed but execution is continued e)
1197 for existing NIC modification interactive verification is needed unless
1198 ``--force`` option is passed.
1200 See **ganeti**\(7) for a description of ``--submit`` and other common
1203 Most of the changes take effect at the next restart. If the instance is
1204 running, there is no effect on the instance.
1209 | **reinstall** [{-o|\--os-type} *os-type*] [\--select-os] [-f *force*]
1210 | [\--force-multiple]
1211 | [\--instance \| \--node \| \--primary \| \--secondary \| \--all]
1212 | [{-O|\--os-parameters} *OS\_PARAMETERS*] [\--submit] {*instance*...}
1214 Reinstalls the operating system on the given instance(s). The
1215 instance(s) must be stopped when running this command. If the ``-o
1216 (--os-type)`` is specified, the operating system is changed.
1218 The ``--select-os`` option switches to an interactive OS reinstall.
1219 The user is prompted to select the OS template from the list of
1220 available OS templates. OS parameters can be overridden using ``-O
1221 (--os-parameters)`` (more documentation for this option under the
1224 Since this is a potentially dangerous command, the user will be
1225 required to confirm this action, unless the ``-f`` flag is passed.
1226 When multiple instances are selected (either by passing multiple
1227 arguments or by using the ``--node``, ``--primary``, ``--secondary``
1228 or ``--all`` options), the user must pass the ``--force-multiple``
1229 options to skip the interactive confirmation.
1231 See **ganeti**\(7) for a description of ``--submit`` and other common
1237 | **rename** [\--no-ip-check] [\--no-name-check] [\--submit]
1238 | {*instance*} {*new\_name*}
1240 Renames the given instance. The instance must be stopped when running
1241 this command. The requirements for the new name are the same as for
1242 adding an instance: the new name must be resolvable and the IP it
1243 resolves to must not be reachable (in order to prevent duplicate IPs
1244 the next time the instance is started). The IP test can be skipped if
1245 the ``--no-ip-check`` option is passed.
1247 Note that you can rename an instance to its same name, to force
1248 re-executing the os-specific rename script for that instance, if
1251 The ``--no-name-check`` skips the check for the new instance name via
1252 the resolver (e.g. in DNS or /etc/hosts, depending on your setup) and
1253 that the resolved name matches the provided name. Since the name check
1254 is used to compute the IP address, if you pass this option you must also
1255 pass the ``--no-ip-check`` option.
1257 See **ganeti**\(7) for a description of ``--submit`` and other common
1260 Starting/stopping/connecting to console
1261 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1267 | [\--force] [\--ignore-offline]
1268 | [\--force-multiple] [\--no-remember]
1269 | [\--instance \| \--node \| \--primary \| \--secondary \| \--all \|
1270 | \--tags \| \--node-tags \| \--pri-node-tags \| \--sec-node-tags]
1271 | [{-H|\--hypervisor-parameters} ``key=value...``]
1272 | [{-B|\--backend-parameters} ``key=value...``]
1273 | [\--submit] [\--paused]
1276 Starts one or more instances, depending on the following options. The
1277 four available modes are:
1280 will start the instances given as arguments (at least one argument
1281 required); this is the default selection
1284 will start the instances who have the given node as either primary
1288 will start all instances whose primary node is in the list of nodes
1289 passed as arguments (at least one node required)
1292 will start all instances whose secondary node is in the list of
1293 nodes passed as arguments (at least one node required)
1296 will start all instances in the cluster (no arguments accepted)
1299 will start all instances in the cluster with the tags given as
1303 will start all instances in the cluster on nodes with the tags
1307 will start all instances in the cluster on primary nodes with the
1308 tags given as arguments
1311 will start all instances in the cluster on secondary nodes with the
1312 tags given as arguments
1314 Note that although you can pass more than one selection option, the
1315 last one wins, so in order to guarantee the desired result, don't pass
1316 more than one such option.
1318 Use ``--force`` to start even if secondary disks are failing.
1319 ``--ignore-offline`` can be used to ignore offline primary nodes and
1320 mark the instance as started even if the primary is not available.
1322 The ``--force-multiple`` will skip the interactive confirmation in the
1323 case the more than one instance will be affected.
1325 The ``--no-remember`` option will perform the startup but not change
1326 the state of the instance in the configuration file (if it was stopped
1327 before, Ganeti will still think it needs to be stopped). This can be
1328 used for testing, or for a one shot-start where you don't want the
1329 watcher to restart the instance if it crashes.
1331 The ``-H (--hypervisor-parameters)`` and ``-B (--backend-parameters)``
1332 options specify temporary hypervisor and backend parameters that can
1333 be used to start an instance with modified parameters. They can be
1334 useful for quick testing without having to modify an instance back and
1337 # gnt-instance start -H kernel_args="single" instance1
1338 # gnt-instance start -B maxmem=2048 instance2
1341 The first form will start the instance instance1 in single-user mode,
1342 and the instance instance2 with 2GB of RAM (this time only, unless
1343 that is the actual instance memory size already). Note that the values
1344 override the instance parameters (and not extend them): an instance
1345 with "kernel\_args=ro" when started with -H kernel\_args=single will
1346 result in "single", not "ro single".
1348 The ``--paused`` option is only valid for Xen and kvm hypervisors. This
1349 pauses the instance at the start of bootup, awaiting ``gnt-instance
1350 console`` to unpause it, allowing the entire boot process to be
1351 monitored for debugging.
1353 See **ganeti**\(7) for a description of ``--submit`` and other common
1358 # gnt-instance start instance1.example.com
1359 # gnt-instance start --node node1.example.com node2.example.com
1360 # gnt-instance start --all
1368 | [\--force] [\--force-multiple] [\--ignore-offline] [\--no-remember]
1369 | [\--instance \| \--node \| \--primary \| \--secondary \| \--all \|
1370 | \--tags \| \--node-tags \| \--pri-node-tags \| \--sec-node-tags]
1374 Stops one or more instances. If the instance cannot be cleanly stopped
1375 during a hardcoded interval (currently 2 minutes), it will forcibly
1376 stop the instance (equivalent to switching off the power on a physical
1379 The ``--timeout`` is used to specify how much time to wait before
1380 forcing the shutdown (e.g. ``xm destroy`` in Xen, killing the kvm
1381 process for KVM, etc.). By default two minutes are given to each
1384 The ``--instance``, ``--node``, ``--primary``, ``--secondary``,
1385 ``--all``, ``--tags``, ``--node-tags``, ``--pri-node-tags`` and
1386 ``--sec-node-tags`` options are similar as for the **startup** command
1387 and they influence the actual instances being shutdown.
1389 ``--ignore-offline`` can be used to ignore offline primary nodes and
1390 force the instance to be marked as stopped. This option should be used
1391 with care as it can lead to an inconsistent cluster state.
1393 Use ``--force`` to be able to shutdown an instance even when it's marked
1394 as offline. This is useful is an offline instance ends up in the
1395 ``ERROR_up`` state, for example.
1397 The ``--no-remember`` option will perform the shutdown but not change
1398 the state of the instance in the configuration file (if it was running
1399 before, Ganeti will still thinks it needs to be running). This can be
1400 useful for a cluster-wide shutdown, where some instances are marked as
1401 up and some as down, and you don't want to change the running state:
1402 you just need to disable the watcher, shutdown all instances with
1403 ``--no-remember``, and when the watcher is activated again it will
1404 restore the correct runtime state for all instances.
1406 See **ganeti**\(7) for a description of ``--submit`` and other common
1411 # gnt-instance shutdown instance1.example.com
1412 # gnt-instance shutdown --all
1419 | [{-t|\--type} *REBOOT-TYPE*]
1420 | [\--ignore-secondaries]
1421 | [\--shutdown-timeout=*N*]
1422 | [\--force-multiple]
1423 | [\--instance \| \--node \| \--primary \| \--secondary \| \--all \|
1424 | \--tags \| \--node-tags \| \--pri-node-tags \| \--sec-node-tags]
1428 Reboots one or more instances. The type of reboot depends on the value
1429 of ``-t (--type)``. A soft reboot does a hypervisor reboot, a hard reboot
1430 does a instance stop, recreates the hypervisor config for the instance
1431 and starts the instance. A full reboot does the equivalent of
1432 **gnt-instance shutdown && gnt-instance startup**. The default is
1435 For the hard reboot the option ``--ignore-secondaries`` ignores errors
1436 for the secondary node while re-assembling the instance disks.
1438 The ``--instance``, ``--node``, ``--primary``, ``--secondary``,
1439 ``--all``, ``--tags``, ``--node-tags``, ``--pri-node-tags`` and
1440 ``--sec-node-tags`` options are similar as for the **startup** command
1441 and they influence the actual instances being rebooted.
1443 The ``--shutdown-timeout`` is used to specify how much time to wait
1444 before forcing the shutdown (xm destroy in xen, killing the kvm
1445 process, for kvm). By default two minutes are given to each instance
1448 The ``--force-multiple`` will skip the interactive confirmation in the
1449 case the more than one instance will be affected.
1451 See **ganeti**\(7) for a description of ``--submit`` and other common
1456 # gnt-instance reboot instance1.example.com
1457 # gnt-instance reboot --type=full instance1.example.com
1463 **console** [\--show-cmd] {*instance*}
1465 Connects to the console of the given instance. If the instance is not
1466 up, an error is returned. Use the ``--show-cmd`` option to display the
1467 command instead of executing it.
1469 For HVM instances, this will attempt to connect to the serial console
1470 of the instance. To connect to the virtualized "physical" console of a
1471 HVM instance, use a VNC client with the connection info from the
1474 For Xen/kvm instances, if the instance is paused, this attempts to
1475 unpause the instance after waiting a few seconds for the connection to
1476 the console to be made.
1480 # gnt-instance console instance1.example.com
1489 **replace-disks** [\--submit] [\--early-release] [\--ignore-ipolicy] {-p}
1490 [\--disks *idx*] {*instance*}
1492 **replace-disks** [\--submit] [\--early-release] [\--ignore-ipolicy] {-s}
1493 [\--disks *idx*] {*instance*}
1495 **replace-disks** [\--submit] [\--early-release] [\--ignore-ipolicy]
1496 {{-I\|\--iallocator} *name* \| {{-n|\--new-secondary} *node* } {*instance*}
1498 **replace-disks** [\--submit] [\--early-release] [\--ignore-ipolicy]
1499 {-a\|\--auto} {*instance*}
1501 This command is a generalized form for replacing disks. It is
1502 currently only valid for the mirrored (DRBD) disk template.
1504 The first form (when passing the ``-p`` option) will replace the disks
1505 on the primary, while the second form (when passing the ``-s`` option
1506 will replace the disks on the secondary node. For these two cases (as
1507 the node doesn't change), it is possible to only run the replace for a
1508 subset of the disks, using the option ``--disks`` which takes a list
1509 of comma-delimited disk indices (zero-based), e.g. 0,2 to replace only
1510 the first and third disks.
1512 The third form (when passing either the ``--iallocator`` or the
1513 ``--new-secondary`` option) is designed to change secondary node of the
1514 instance. Specifying ``--iallocator`` makes the new secondary be
1515 selected automatically by the specified allocator plugin (use ``.`` to
1516 indicate the default allocator), otherwise the new secondary node will
1517 be the one chosen manually via the ``--new-secondary`` option.
1519 Note that it is not possible to select an offline or drained node as a
1522 The fourth form (when using ``--auto``) will automatically determine
1523 which disks of an instance are faulty and replace them within the same
1524 node. The ``--auto`` option works only when an instance has only
1525 faulty disks on either the primary or secondary node; it doesn't work
1526 when both sides have faulty disks.
1528 The ``--early-release`` changes the code so that the old storage on
1529 secondary node(s) is removed early (before the resync is completed)
1530 and the internal Ganeti locks for the current (and new, if any)
1531 secondary node are also released, thus allowing more parallelism in
1532 the cluster operation. This should be used only when recovering from a
1533 disk failure on the current secondary (thus the old storage is already
1534 broken) or when the storage on the primary node is known to be fine
1535 (thus we won't need the old storage for potential recovery).
1537 The ``--ignore-ipolicy`` let the command ignore instance policy
1538 violations if replace-disks changes groups and the instance would
1539 violate the new groups instance policy.
1541 See **ganeti**\(7) for a description of ``--submit`` and other common
1547 **activate-disks** [\--submit] [\--ignore-size] [\--wait-for-sync] {*instance*}
1549 Activates the block devices of the given instance. If successful, the
1550 command will show the location and name of the block devices::
1552 node1.example.com:disk/0:/dev/drbd0
1553 node1.example.com:disk/1:/dev/drbd1
1556 In this example, *node1.example.com* is the name of the node on which
1557 the devices have been activated. The *disk/0* and *disk/1* are the
1558 Ganeti-names of the instance disks; how they are visible inside the
1559 instance is hypervisor-specific. */dev/drbd0* and */dev/drbd1* are the
1560 actual block devices as visible on the node.
1562 The ``--ignore-size`` option can be used to activate disks ignoring
1563 the currently configured size in Ganeti. This can be used in cases
1564 where the configuration has gotten out of sync with the real-world
1565 (e.g. after a partially-failed grow-disk operation or due to rounding
1566 in LVM devices). This should not be used in normal cases, but only
1567 when activate-disks fails without it.
1569 The ``--wait-for-sync`` option will ensure that the command returns only
1570 after the instance's disks are synchronised (mostly for DRBD); this can
1571 be useful to ensure consistency, as otherwise there are no commands that
1572 can wait until synchronisation is done. However when passing this
1573 option, the command will have additional output, making it harder to
1574 parse the disk information.
1576 Note that it is safe to run this command while the instance is already
1579 See **ganeti**\(7) for a description of ``--submit`` and other common
1585 **deactivate-disks** [-f] [\--submit] {*instance*}
1587 De-activates the block devices of the given instance. Note that if you
1588 run this command for an instance with a drbd disk template, while it
1589 is running, it will not be able to shutdown the block devices on the
1590 primary node, but it will shutdown the block devices on the secondary
1591 nodes, thus breaking the replication.
1593 The ``-f``/``--force`` option will skip checks that the instance is
1594 down; in case the hypervisor is confused and we can't talk to it,
1595 normally Ganeti will refuse to deactivate the disks, but with this
1596 option passed it will skip this check and directly try to deactivate
1597 the disks. This can still fail due to the instance actually running or
1600 See **ganeti**\(7) for a description of ``--submit`` and other common
1606 | **grow-disk** [\--no-wait-for-sync] [\--submit] [\--absolute]
1607 | {*instance*} {*disk*} {*amount*}
1609 Grows an instance's disk. This is only possible for instances having a
1610 plain, drbd, file, sharedfile, rbd or ext disk template. For the ext
1611 template to work, the ExtStorage provider should also support growing.
1612 This means having a ``grow`` script that actually grows the volume of
1613 the external shared storage.
1615 Note that this command only change the block device size; it will not
1616 grow the actual filesystems, partitions, etc. that live on that
1617 disk. Usually, you will need to:
1619 #. use **gnt-instance grow-disk**
1621 #. reboot the instance (later, at a convenient time)
1623 #. use a filesystem resizer, such as **ext2online**\(8) or
1624 **xfs\_growfs**\(8) to resize the filesystem, or use **fdisk**\(8) to
1625 change the partition table on the disk
1627 The *disk* argument is the index of the instance disk to grow. The
1628 *amount* argument is given as a number which can have a suffix (like the
1629 disk size in instance create); if the suffix is missing, the value will
1630 be interpreted as mebibytes.
1632 By default, the *amount* value represents the desired increase in the
1633 disk size (e.g. an amount of 1G will take a disk of size 3G to 4G). If
1634 the optional ``--absolute`` parameter is passed, then the *amount*
1635 argument doesn't represent the delta, but instead the desired final disk
1636 size (e.g. an amount of 8G will take a disk of size 4G to 8G).
1638 For instances with a drbd template, note that the disk grow operation
1639 might complete on one node but fail on the other; this will leave the
1640 instance with different-sized LVs on the two nodes, but this will not
1641 create problems (except for unused space).
1643 If you do not want gnt-instance to wait for the new disk region to be
1644 synced, use the ``--no-wait-for-sync`` option.
1646 See **ganeti**\(7) for a description of ``--submit`` and other common
1649 Example (increase the first disk for instance1 by 16GiB)::
1651 # gnt-instance grow-disk instance1.example.com 0 16g
1653 Example for increasing the disk size to a certain size::
1655 # gnt-instance grow-disk --absolute instance1.example.com 0 32g
1657 Also note that disk shrinking is not supported; use **gnt-backup
1658 export** and then **gnt-backup import** to reduce the disk size of an
1664 | **recreate-disks** [\--submit]
1665 | [{-n node1:[node2] \| {-I\|\--iallocator *name*}}]
1666 | [\--disk=*N*[:[size=*VAL*][,mode=*ro\|rw*]]] {*instance*}
1668 Recreates all or a subset of disks of the given instance.
1670 Note that this functionality should only be used for missing disks; if
1671 any of the given disks already exists, the operation will fail. While
1672 this is suboptimal, recreate-disks should hopefully not be needed in
1673 normal operation and as such the impact of this is low.
1675 If only a subset should be recreated, any number of ``disk`` options can
1676 be specified. It expects a disk index and an optional list of disk
1677 parameters to change. Only ``size`` and ``mode`` can be changed while
1678 recreating disks. To recreate all disks while changing parameters on
1679 a subset only, a ``--disk`` option must be given for every disk of the
1682 Optionally the instance's disks can be recreated on different
1683 nodes. This can be useful if, for example, the original nodes of the
1684 instance have gone down (and are marked offline), so we can't recreate
1685 on the same nodes. To do this, pass the new node(s) via ``-n`` option,
1686 with a syntax similar to the **add** command. The number of nodes
1687 passed must equal the number of nodes that the instance currently
1688 has. Note that changing nodes is only allowed when all disks are
1689 replaced, e.g. when no ``--disk`` option is passed.
1691 Another method of choosing which nodes to place the instance on is by
1692 using the specified iallocator, passing the ``--iallocator`` option.
1693 The primary and secondary nodes will be chosen by the specified
1694 iallocator plugin, or by the default allocator if ``.`` is specified.
1696 See **ganeti**\(7) for a description of ``--submit`` and other common
1705 | **failover** [-f] [\--ignore-consistency] [\--ignore-ipolicy]
1706 | [\--shutdown-timeout=*N*]
1707 | [{-n|\--target-node} *node* \| {-I|\--iallocator} *name*]
1708 | [\--submit] [\--cleanup]
1711 Failover will stop the instance (if running), change its primary node,
1712 and if it was originally running it will start it again (on the new
1713 primary). This works for instances with drbd template (in which case you
1714 can only fail to the secondary node) and for externally mirrored
1715 templates (sharedfile, blockdev, rbd and ext) (in which case you can
1716 fail to any other node).
1718 If the instance's disk template is of type sharedfile, blockdev, rbd or
1719 ext, then you can explicitly specify the target node (which can be any
1720 node) using the ``-n`` or ``--target-node`` option, or specify an
1721 iallocator plugin using the ``-I`` or ``--iallocator`` option. If you
1722 omit both, the default iallocator will be used to specify the target
1725 If the instance's disk template is of type drbd, the target node is
1726 automatically selected as the drbd's secondary node. Changing the
1727 secondary node is possible with a replace-disks operation.
1729 Normally the failover will check the consistency of the disks before
1730 failing over the instance. If you are trying to migrate instances off
1731 a dead node, this will fail. Use the ``--ignore-consistency`` option
1732 for this purpose. Note that this option can be dangerous as errors in
1733 shutting down the instance will be ignored, resulting in possibly
1734 having the instance running on two machines in parallel (on
1735 disconnected DRBD drives).
1737 The ``--shutdown-timeout`` is used to specify how much time to wait
1738 before forcing the shutdown (xm destroy in xen, killing the kvm
1739 process, for kvm). By default two minutes are given to each instance
1742 If ``--ignore-ipolicy`` is given any instance policy violations occuring
1743 during this operation are ignored.
1745 If the ``--cleanup`` option is passed, the operation changes from
1746 performin a failover to attempting recovery from a failed previous failover.
1747 In this mode, Ganeti checks if the instance runs on the correct node (and
1748 updates its configuration if not) and ensures the instances' disks
1749 are configured correctly.
1751 See **ganeti**\(7) for a description of ``--submit`` and other common
1756 # gnt-instance failover instance1.example.com
1758 For externally mirrored templates also ``-n`` is available::
1760 # gnt-instance failover -n node3.example.com instance1.example.com
1766 | **migrate** [-f] [\--allow-failover] [\--non-live]
1767 | [\--migration-mode=live\|non-live] [\--ignore-ipolicy]
1768 | [\--no-runtime-changes] [\--submit]
1769 | [{-n|\--target-node} *node* \| {-I|\--iallocator} *name*] {*instance*}
1771 | **migrate** [-f] \--cleanup [\--submit] {*instance*}
1773 Migrate will move the instance to its secondary node without shutdown.
1774 As with failover, it works for instances having the drbd disk template
1775 or an externally mirrored disk template type such as sharedfile,
1776 blockdev, rbd or ext.
1778 If the instance's disk template is of type sharedfile, blockdev, rbd or
1779 ext, then you can explicitly specify the target node (which can be any
1780 node) using the ``-n`` or ``--target-node`` option, or specify an
1781 iallocator plugin using the ``-I`` or ``--iallocator`` option. If you
1782 omit both, the default iallocator will be used to specify the target
1783 node. Alternatively, the default iallocator can be requested by
1784 specifying ``.`` as the name of the plugin.
1786 If the instance's disk template is of type drbd, the target node is
1787 automatically selected as the drbd's secondary node. Changing the
1788 secondary node is possible with a replace-disks operation.
1790 The migration command needs a perfectly healthy instance for drbd
1791 instances, as we rely on the dual-master capability of drbd8 and the
1792 disks of the instance are not allowed to be degraded.
1794 The ``--non-live`` and ``--migration-mode=non-live`` options will
1795 switch (for the hypervisors that support it) between a "fully live"
1796 (i.e. the interruption is as minimal as possible) migration and one in
1797 which the instance is frozen, its state saved and transported to the
1798 remote node, and then resumed there. This all depends on the
1799 hypervisor support for two different methods. In any case, it is not
1800 an error to pass this parameter (it will just be ignored if the
1801 hypervisor doesn't support it). The option ``--migration-mode=live``
1802 option will request a fully-live migration. The default, when neither
1803 option is passed, depends on the hypervisor parameters (and can be
1804 viewed with the **gnt-cluster info** command).
1806 If the ``--cleanup`` option is passed, the operation changes from
1807 migration to attempting recovery from a failed previous migration. In
1808 this mode, Ganeti checks if the instance runs on the correct node (and
1809 updates its configuration if not) and ensures the instances' disks
1810 are configured correctly. In this mode, the ``--non-live`` option is
1813 The option ``-f`` will skip the prompting for confirmation.
1815 If ``--allow-failover`` is specified it tries to fallback to failover if
1816 it already can determine that a migration won't work (e.g. if the
1817 instance is shut down). Please note that the fallback will not happen
1818 during execution. If a migration fails during execution it still fails.
1820 If ``--ignore-ipolicy`` is given any instance policy violations occuring
1821 during this operation are ignored.
1823 The ``--no-runtime-changes`` option forbids migrate to alter an
1824 instance's runtime before migrating it (eg. ballooning an instance
1825 down because the target node doesn't have enough available memory).
1827 If an instance has the backend parameter ``always_failover`` set to
1828 true, then the migration is automatically converted into a failover.
1830 See **ganeti**\(7) for a description of ``--submit`` and other common
1833 Example (and expected output)::
1835 # gnt-instance migrate instance1
1836 Instance instance1 will be migrated. Note that migration
1837 might impact the instance if anything goes wrong (e.g. due to bugs in
1838 the hypervisor). Continue?
1840 Migrating instance instance1.example.com
1841 * checking disk consistency between source and target
1842 * switching node node2.example.com to secondary mode
1843 * changing into standalone mode
1844 * changing disks into dual-master mode
1845 * wait until resync is done
1846 * preparing node2.example.com to accept the instance
1847 * migrating instance to node2.example.com
1848 * switching node node1.example.com to secondary mode
1849 * wait until resync is done
1850 * changing into standalone mode
1851 * changing disks into single-master mode
1852 * wait until resync is done
1860 | **move** [-f] [\--ignore-consistency]
1861 | [-n *node*] [\--shutdown-timeout=*N*] [\--submit] [\--ignore-ipolicy]
1864 Move will move the instance to an arbitrary node in the cluster. This
1865 works only for instances having a plain or file disk template.
1867 Note that since this operation is done via data copy, it will take a
1868 long time for big disks (similar to replace-disks for a drbd
1871 The ``--shutdown-timeout`` is used to specify how much time to wait
1872 before forcing the shutdown (e.g. ``xm destroy`` in XEN, killing the
1873 kvm process for KVM, etc.). By default two minutes are given to each
1876 The ``--ignore-consistency`` option will make Ganeti ignore any errors
1877 in trying to shutdown the instance on its node; useful if the
1878 hypervisor is broken and you want to recover the data.
1880 If ``--ignore-ipolicy`` is given any instance policy violations occuring
1881 during this operation are ignored.
1883 See **ganeti**\(7) for a description of ``--submit`` and other common
1888 # gnt-instance move -n node3.example.com instance1.example.com
1894 | **change-group** [\--submit]
1895 | [\--iallocator *NAME*] [\--to *GROUP*...] {*instance*}
1897 This command moves an instance to another node group. The move is
1898 calculated by an iallocator, either given on the command line or as a
1901 If no specific destination groups are specified using ``--to``, all
1902 groups except the one containing the instance are considered.
1904 See **ganeti**\(7) for a description of ``--submit`` and other common
1909 # gnt-instance change-group -I hail --to rack2 inst1.example.com
1918 **add-tags** [\--from *file*] {*instancename*} {*tag*...}
1920 Add tags to the given instance. If any of the tags contains invalid
1921 characters, the entire operation will abort.
1923 If the ``--from`` option is given, the list of tags will be extended
1924 with the contents of that file (each line becomes a tag). In this
1925 case, there is not need to pass tags on the command line (if you do,
1926 both sources will be used). A file name of ``-`` will be interpreted
1932 **list-tags** {*instancename*}
1934 List the tags of the given instance.
1939 **remove-tags** [\--from *file*] {*instancename*} {*tag*...}
1941 Remove tags from the given instance. If any of the tags are not
1942 existing on the node, the entire operation will abort.
1944 If the ``--from`` option is given, the list of tags to be removed will
1945 be extended with the contents of that file (each line becomes a tag).
1946 In this case, there is not need to pass tags on the command line (if
1947 you do, tags from both sources will be removed). A file name of ``-``
1948 will be interpreted as stdin.
1950 .. vim: set textwidth=72 :