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 | \| {-s|\--os-size} *SIZE*}
33 | [\--no-ip-check] [\--no-name-check] [\--no-start] [\--no-install]
34 | [\--net=*N* [:options...] \| \--no-nics]
35 | [{-B|\--backend-parameters} *BEPARAMS*]
36 | [{-H|\--hypervisor-parameters} *HYPERVISOR* [: option=*value*... ]]
37 | [{-O|\--os-parameters} *param*=*value*... ]
38 | [\--file-storage-dir *dir\_path*] [\--file-driver {loop \| blktap}]
39 | {{-n|\--node} *node[:secondary-node]* \| {-I|\--iallocator} *name*}
40 | {{-o|\--os-type} *os-type*}
45 Creates a new instance on the specified host. The *instance* argument
46 must be in DNS, but depending on the bridge/routing setup, need not be
47 in the same network as the nodes in the cluster.
49 The ``disk`` option specifies the parameters for the disks of the
50 instance. The numbering of disks starts at zero, and at least one disk
51 needs to be passed. For each disk, either the size or the adoption
52 source needs to be given, and optionally the access mode (read-only or
53 the default of read-write) and the LVM volume group can also be
54 specified (via the ``vg`` key). For DRBD devices, a different VG can
55 be specified for the metadata device using the ``metavg`` key. The
56 size is interpreted (when no unit is given) in mebibytes. You can also
57 use one of the suffixes *m*, *g* or *t* to specify the exact the units
58 used; these suffixes map to mebibytes, gibibytes and tebibytes.
60 When using the ``adopt`` key in the disk definition, Ganeti will
61 reuse those volumes (instead of creating new ones) as the
62 instance's disks. Ganeti will rename these volumes to the standard
63 format, and (without installing the OS) will use them as-is for the
64 instance. This allows migrating instances from non-managed mode
65 (e.g. plain KVM with LVM) to being managed via Ganeti. Please note that
66 this works only for the \`plain' disk template (see below for
69 Alternatively, a single-disk instance can be created via the ``-s``
70 option which takes a single argument, the size of the disk. This is
71 similar to the Ganeti 1.2 version (but will only create one disk).
73 The minimum disk specification is therefore ``--disk 0:size=20G`` (or
74 ``-s 20G`` when using the ``-s`` option), and a three-disk instance
75 can be specified as ``--disk 0:size=20G --disk 1:size=4G --disk
78 The ``--no-ip-check`` skips the checks that are done to see if the
79 instance's IP is not already alive (i.e. reachable from the master
82 The ``--no-name-check`` skips the check for the instance name via
83 the resolver (e.g. in DNS or /etc/hosts, depending on your setup).
84 Since the name check is used to compute the IP address, if you pass
85 this option you must also pass the ``--no-ip-check`` option.
87 If you don't want the instance to automatically start after
88 creation, this is possible via the ``--no-start`` option. This will
89 leave the instance down until a subsequent **gnt-instance start**
92 The NICs of the instances can be specified via the ``--net``
93 option. By default, one NIC is created for the instance, with a
94 random MAC, and set up according the the cluster level nic
95 parameters. Each NIC can take these parameters (all optional):
98 either a value or 'generate' to generate a new unique MAC
101 specifies the IP address assigned to the instance from the Ganeti
102 side (this is not necessarily what the instance will use, but what
103 the node expects the instance to use)
106 specifies the connection mode for this nic: routed or bridged.
109 in bridged mode specifies the bridge to attach this NIC to, in
110 routed mode it's intended to differentiate between different
111 routing tables/instance groups (but the meaning is dependent on
112 the network script, see gnt-cluster(8) for more details)
115 Of these "mode" and "link" are nic parameters, and inherit their
116 default at cluster level. Alternatively, if no network is desired for
117 the instance, you can prevent the default of one NIC with the
118 ``--no-nics`` option.
120 The ``-o (--os-type)`` option specifies the operating system to be
121 installed. The available operating systems can be listed with
122 **gnt-os list**. Passing ``--no-install`` will however skip the OS
123 installation, allowing a manual import if so desired. Note that the
124 no-installation mode will automatically disable the start-up of the
125 instance (without an OS, it most likely won't be able to start-up
128 The ``-B (--backend-parameters)`` option specifies the backend
129 parameters for the instance. If no such parameters are specified, the
130 values are inherited from the cluster. Possible parameters are:
133 the maximum memory size of the instance; as usual, suffixes can be
134 used to denote the unit, otherwise the value is taken in mebibytes
137 the minimum memory size of the instance; as usual, suffixes can be
138 used to denote the unit, otherwise the value is taken in mebibytes
141 the number of VCPUs to assign to the instance (if this value makes
142 sense for the hypervisor)
145 whether the instance is considered in the N+1 cluster checks
146 (enough redundancy in the cluster to survive a node failure)
149 ``True`` or ``False``, whether the instance must be failed over
150 (shut down and rebooted) always or it may be migrated (briefly
153 Note that before 2.6 Ganeti had a ``memory`` parameter, which was the
154 only value of memory an instance could have. With the
155 ``maxmem``/``minmem`` change Ganeti guarantees that at least the minimum
156 memory is always available for an instance, but allows more memory to be
157 used (up to the maximum memory) should it be free.
159 The ``-H (--hypervisor-parameters)`` option specified the hypervisor
160 to use for the instance (must be one of the enabled hypervisors on the
161 cluster) and optionally custom parameters for this instance. If not
162 other options are used (i.e. the invocation is just -H *NAME*) the
163 instance will inherit the cluster options. The defaults below show the
164 cluster defaults at cluster creation time.
166 The possible hypervisor options are as follows:
169 Valid for the Xen HVM and KVM hypervisors.
171 A string value denoting the boot order. This has different meaning
172 for the Xen HVM hypervisor and for the KVM one.
174 For Xen HVM, The boot order is a string of letters listing the boot
175 devices, with valid device letters being:
189 The default is not to set an HVM boot order, which is interpreted
192 For KVM the boot order is either "floppy", "cdrom", "disk" or
193 "network". Please note that older versions of KVM couldn't netboot
194 from virtio interfaces. This has been fixed in more recent versions
195 and is confirmed to work at least with qemu-kvm 0.11.1. Also note
196 that if you have set the ``kernel_path`` option, that will be used
197 for booting, and this setting will be silently ignored.
200 Valid for the Xen HVM and PVM hypervisors.
202 Relevant to non-pvops guest kernels, in which the disk device names
203 are given by the host. Allows one to specify 'xvd', which helps run
204 Red Hat based installers, driven by anaconda.
207 Valid for the KVM hypervisor.
209 The path to a floppy disk image to attach to the instance. This
210 is useful to install Windows operating systems on Virt/IO disks
211 because you can specify here the floppy for the drivers at
215 Valid for the Xen HVM and KVM hypervisors.
217 The path to a CDROM image to attach to the instance.
220 Valid for the KVM hypervisor.
222 The path to a second CDROM image to attach to the instance.
223 **NOTE**: This image can't be used to boot the system. To do that
224 you have to use the 'cdrom\_image\_path' option.
227 Valid for the Xen HVM and KVM hypervisors.
229 This parameter determines the way the network cards are presented
230 to the instance. The possible options are:
232 - rtl8139 (default for Xen HVM) (HVM & KVM)
233 - ne2k\_isa (HVM & KVM)
234 - ne2k\_pci (HVM & KVM)
240 - paravirtual (default for KVM) (HVM & KVM)
243 Valid for the Xen HVM and KVM hypervisors.
245 This parameter determines the way the disks are presented to the
246 instance. The possible options are:
248 - ioemu [default] (HVM & KVM)
257 Valid for the KVM hypervisor.
259 This parameter determines the way the cdroms disks are presented
260 to the instance. The default behavior is to get the same value of
261 the earlier parameter (disk_type). The possible options are:
272 Valid for the Xen HVM and KVM hypervisors.
274 Specifies the address that the VNC listener for this instance
275 should bind to. Valid values are IPv4 addresses. Use the address
276 0.0.0.0 to bind to all available interfaces (this is the default)
277 or specify the address of one of the interfaces on the node to
278 restrict listening to that interface.
281 Valid for the KVM hypervisor.
283 A boolean option that controls whether the VNC connection is
287 Valid for the KVM hypervisor.
289 If ``vnc_tls`` is enabled, this options specifies the path to the
290 x509 certificate to use.
293 Valid for the KVM hypervisor.
296 Valid for the KVM hypervisor.
298 Specifies the address or interface on which the SPICE server will
299 listen. Valid values are:
301 - IPv4 addresses, including 0.0.0.0 and 127.0.0.1
302 - IPv6 addresses, including :: and ::1
303 - names of network interfaces
305 If a network interface is specified, the SPICE server will be bound
306 to one of the addresses of that interface.
309 Valid for the KVM hypervisor.
311 Specifies which version of the IP protocol should be used by the
314 It is mainly intended to be used for specifying what kind of IP
315 addresses should be used if a network interface with both IPv4 and
316 IPv6 addresses is specified via the ``spice_bind`` parameter. In
317 this case, if the ``spice_ip_version`` parameter is not used, the
318 default IP version of the cluster will be used.
320 spice\_password\_file
321 Valid for the KVM hypervisor.
323 Specifies a file containing the password that must be used when
324 connecting via the SPICE protocol. If the option is not specified,
325 passwordless connections are allowed.
327 spice\_image\_compression
328 Valid for the KVM hypervisor.
330 Configures the SPICE lossless image compression. Valid values are:
339 spice\_jpeg\_wan\_compression
340 Valid for the KVM hypervisor.
342 Configures how SPICE should use the jpeg algorithm for lossy image
343 compression on slow links. Valid values are:
349 spice\_zlib\_glz\_wan\_compression
350 Valid for the KVM hypervisor.
352 Configures how SPICE should use the zlib-glz algorithm for lossy image
353 compression on slow links. Valid values are:
359 spice\_streaming\_video
360 Valid for the KVM hypervisor.
362 Configures how SPICE should detect video streams. Valid values are:
368 spice\_playback\_compression
369 Valid for the KVM hypervisor.
371 Configures whether SPICE should compress audio streams or not.
374 Valid for the KVM hypervisor.
376 Specifies that the SPICE server must use TLS to encrypt all the
377 traffic with the client.
380 Valid for the KVM hypervisor.
382 Specifies a list of comma-separated ciphers that SPICE should use
383 for TLS connections. For the format, see man cipher(1).
386 Valid for the KVM hypervisor.
388 Enables or disables passing mouse events via SPICE vdagent.
391 Valid for the KVM hypervisor.
393 This parameter determines the emulated cpu for the instance. If this
394 parameter is empty (which is the default configuration), it will not
397 Be aware of setting this parameter to ``"host"`` if you have nodes
398 with different CPUs from each other. Live migration may stop working
401 For more information please refer to the KVM manual.
404 Valid for the Xen HVM and KVM hypervisors.
406 A boolean option that specifies if the hypervisor should enable
407 ACPI support for this instance. By default, ACPI is disabled.
410 Valid for the Xen HVM and KVM hypervisors.
412 A boolean option that specifies if the hypervisor should enabled
413 PAE support for this instance. The default is false, disabling PAE
417 Valid for the Xen HVM and KVM hypervisors.
419 A boolean option that specifies if the instance should be started
420 with its clock set to the localtime of the machine (when true) or
421 to the UTC (When false). The default is false, which is useful for
422 Linux/Unix machines; for Windows OSes, it is recommended to enable
426 Valid for the Xen PVM and KVM hypervisors.
428 This option specifies the path (on the node) to the kernel to boot
429 the instance with. Xen PVM instances always require this, while for
430 KVM if this option is empty, it will cause the machine to load the
431 kernel from its disks (and the boot will be done accordingly to
435 Valid for the Xen PVM and KVM hypervisors.
437 This options specifies extra arguments to the kernel that will be
438 loaded. device. This is always used for Xen PVM, while for KVM it
439 is only used if the ``kernel_path`` option is also specified.
441 The default setting for this value is simply ``"ro"``, which
442 mounts the root disk (initially) in read-only one. For example,
443 setting this to single will cause the instance to start in
447 Valid for the Xen PVM and KVM hypervisors.
449 This option specifies the path (on the node) to the initrd to boot
450 the instance with. Xen PVM instances can use this always, while
451 for KVM if this option is only used if the ``kernel_path`` option
452 is also specified. You can pass here either an absolute filename
453 (the path to the initrd) if you want to use an initrd, or use the
454 format no\_initrd\_path for no initrd.
457 Valid for the Xen PVM and KVM hypervisors.
459 This options specifies the name of the root device. This is always
460 needed for Xen PVM, while for KVM it is only used if the
461 ``kernel_path`` option is also specified.
463 Please note, that if this setting is an empty string and the
464 hypervisor is Xen it will not be written to the Xen configuration
468 Valid for the KVM hypervisor.
470 This boolean option specifies whether to emulate a serial console
474 Valid for the KVM hypervisor.
476 The disk cache mode. It can be either default to not pass any
477 cache option to KVM, or one of the KVM cache modes: none (for
478 direct I/O), writethrough (to use the host cache but report
479 completion to the guest only when the host has committed the
480 changes to disk) or writeback (to use the host cache and report
481 completion as soon as the data is in the host cache). Note that
482 there are special considerations for the cache mode depending on
483 version of KVM used and disk type (always raw file under Ganeti),
484 please refer to the KVM documentation for more details.
487 Valid for the KVM hypervisor.
489 The security model for kvm. Currently one of *none*, *user* or
490 *pool*. Under *none*, the default, nothing is done and instances
491 are run as the Ganeti daemon user (normally root).
493 Under *user* kvm will drop privileges and become the user
494 specified by the security\_domain parameter.
496 Under *pool* a global cluster pool of users will be used, making
497 sure no two instances share the same user on the same node. (this
498 mode is not implemented yet)
501 Valid for the KVM hypervisor.
503 Under security model *user* the username to run the instance
504 under. It must be a valid username existing on the host.
506 Cannot be set under security model *none* or *pool*.
509 Valid for the KVM hypervisor.
511 If *enabled* the -enable-kvm flag is passed to kvm. If *disabled*
512 -disable-kvm is passed. If unset no flag is passed, and the
513 default running mode for your kvm binary will be used.
516 Valid for the KVM hypervisor.
518 This option passes the -mem-path argument to kvm with the path (on
519 the node) to the mount point of the hugetlbfs file system, along
520 with the -mem-prealloc argument too.
523 Valid for the KVM hypervisor.
525 This boolean option determines whether to run the KVM instance in a
528 If it is set to ``true``, an empty directory is created before
529 starting the instance and its path is passed via the -chroot flag
530 to kvm. The directory is removed when the instance is stopped.
532 It is set to ``false`` by default.
535 Valid for the KVM hypervisor.
537 The maximum amount of time (in ms) a KVM instance is allowed to be
538 frozen during a live migration, in order to copy dirty memory
539 pages. Default value is 30ms, but you may need to increase this
540 value for busy instances.
542 This option is only effective with kvm versions >= 87 and qemu-kvm
546 Valid for the Xen, KVM and LXC hypervisors.
548 The processes belonging to the given instance are only scheduled
549 on the specified CPUs.
551 The format of the mask can be given in three forms. First, the word
552 "all", which signifies the common case where all VCPUs can live on
553 any CPU, based on the hypervisor's decisions.
555 Second, a comma-separated list of CPU IDs or CPU ID ranges. The
556 ranges are defined by a lower and higher boundary, separated by a
557 dash, and the boundaries are inclusive. In this form, all VCPUs of
558 the instance will be mapped on the selected list of CPUs. Example:
559 ``0-2,5``, mapping all VCPUs (no matter how many) onto physical CPUs
562 The last form is used for explicit control of VCPU-CPU pinnings. In
563 this form, the list of VCPU mappings is given as a colon (:)
564 separated list, whose elements are the possible values for the
565 second or first form above. In this form, the number of elements in
566 the colon-separated list _must_ equal the number of VCPUs of the
573 # Map the entire instance to CPUs 0-2
574 gnt-instance modify -H cpu_mask=0-2 my-inst
576 # Map vCPU 0 to physical CPU 1 and vCPU 1 to CPU 3 (assuming 2 vCPUs)
577 gnt-instance modify -H cpu_mask=1:3 my-inst
579 # Pin vCPU 0 to CPUs 1 or 2, and vCPU 1 to any CPU
580 gnt-instance modify -H cpu_mask=1-2:all my-inst
582 # Pin vCPU 0 to any CPU, vCPU 1 to CPUs 1, 3, 4 or 5, and CPU 2 to
583 # CPU 0 (backslashes for escaping the comma)
584 gnt-instance modify -H cpu_mask=all:1\\,3-5:0 my-inst
586 # Pin entire VM to CPU 0
587 gnt-instance modify -H cpu_mask=0 my-inst
589 # Turn off CPU pinning (default setting)
590 gnt-instance modify -H cpu_mask=all my-inst
593 Valid for the Xen hypervisor.
595 Set the maximum amount of cpu usage by the VM. The value is a percentage
596 between 0 and (100 * number of VCPUs). Default cap is 0: unlimited.
599 Valid for the Xen hypervisor.
601 Set the cpu time ratio to be allocated to the VM. Valid values are
602 between 1 and 65535. Default weight is 256.
605 Valid for the KVM hypervisor.
607 This option specifies the usb mouse type to be used. It can be
608 "mouse" or "tablet". When using VNC it's recommended to set it to
612 Valid for the KVM hypervisor.
614 This option specifies the keyboard mapping to be used. It is only
615 needed when using the VNC console. For example: "fr" or "en-gb".
618 Valid for Xen PVM, Xen HVM and KVM hypervisors.
620 Normally if an instance reboots, the hypervisor will restart it. If
621 this option is set to ``exit``, the hypervisor will treat a reboot
622 as a shutdown instead.
624 It is set to ``reboot`` by default.
627 The ``-O (--os-parameters)`` option allows customisation of the OS
628 parameters. The actual parameter names and values depends on the OS
629 being used, but the syntax is the same key=value. For example, setting
630 a hypothetical ``dhcp`` parameter to yes can be achieved by::
632 gnt-instance add -O dhcp=yes ...
634 The ``-I (--iallocator)`` option specifies the instance allocator plugin
635 to use (``.`` means the default allocator). If you pass in this option
636 the allocator will select nodes for this instance automatically, so you
637 don't need to pass them with the ``-n`` option. For more information
638 please refer to the instance allocator documentation.
640 The ``-t (--disk-template)`` options specifies the disk layout type
641 for the instance. The available choices are:
644 This creates an instance with no disks. Its useful for testing only
645 (or other special cases).
648 Disk devices will be regular files.
651 Disk devices will be logical volumes.
654 Disk devices will be drbd (version 8.x) on top of lvm volumes.
657 Disk devices will be rbd volumes residing inside a RADOS cluster.
660 The optional second value of the ``-n (--node)`` is used for the drbd
661 template type and specifies the remote node.
663 If you do not want gnt-instance to wait for the disk mirror to be
664 synced, use the ``--no-wait-for-sync`` option.
666 The ``--file-storage-dir`` specifies the relative path under the
667 cluster-wide file storage directory to store file-based disks. It is
668 useful for having different subdirectories for different
669 instances. The full path of the directory where the disk files are
670 stored will consist of cluster-wide file storage directory + optional
671 subdirectory + instance name. Example:
672 ``@RPL_FILE_STORAGE_DIR@``*/mysubdir/instance1.example.com*. This
673 option is only relevant for instances using the file storage backend.
675 The ``--file-driver`` specifies the driver to use for file-based
676 disks. Note that currently these drivers work with the xen hypervisor
677 only. This option is only relevant for instances using the file
678 storage backend. The available choices are:
681 Kernel loopback driver. This driver uses loopback devices to
682 access the filesystem within the file. However, running I/O
683 intensive applications in your instance using the loop driver
684 might result in slowdowns. Furthermore, if you use the loopback
685 driver consider increasing the maximum amount of loopback devices
686 (on most systems it's 8) using the max\_loop param.
689 The blktap driver (for Xen hypervisors). In order to be able to
690 use the blktap driver you should check if the 'blktapctrl' user
691 space disk agent is running (usually automatically started via
692 xend). This user-level disk I/O interface has the advantage of
693 better performance. Especially if you use a network file system
694 (e.g. NFS) to store your instances this is the recommended choice.
696 If ``--ignore-ipolicy`` is given any instance policy violations occuring
697 during this operation are ignored.
699 See **ganeti(7)** for a description of ``--submit`` and other common
704 # gnt-instance add -t file --disk 0:size=30g -B maxmem=512 -o debian-etch \
705 -n node1.example.com --file-storage-dir=mysubdir instance1.example.com
706 # gnt-instance add -t plain --disk 0:size=30g -B maxmem=1024,minmem=512 \
707 -o debian-etch -n node1.example.com instance1.example.com
708 # gnt-instance add -t plain --disk 0:size=30g --disk 1:size=100g,vg=san \
709 -B maxmem=512 -o debian-etch -n node1.example.com instance1.example.com
710 # gnt-instance add -t drbd --disk 0:size=30g -B maxmem=512 -o debian-etch \
711 -n node1.example.com:node2.example.com instance2.example.com
717 **batch-create** {instances\_file.json}
719 This command (similar to the Ganeti 1.2 **batcher** tool) submits
720 multiple instance creation jobs based on a definition file. The
721 instance configurations do not encompass all the possible options for
722 the **add** command, but only a subset.
724 The instance file should be a valid-formed JSON file, containing a
725 dictionary with instance name and instance parameters. The accepted
729 The size of the disks of the instance.
732 The disk template to use for the instance, the same as in the
736 A dictionary of backend parameters.
739 A dictionary with a single key (the hypervisor name), and as value
740 the hypervisor options. If not passed, the default hypervisor and
741 hypervisor options will be inherited.
744 Specifications for the one NIC that will be created for the
745 instance. 'bridge' is also accepted as a backwards compatible
749 List of nics that will be created for the instance. Each entry
750 should be a dict, with mac, ip, mode and link as possible keys.
751 Please don't provide the "mac, ip, mode, link" parent keys if you
752 use this method for specifying nics.
754 primary\_node, secondary\_node
755 The primary and optionally the secondary node to use for the
756 instance (in case an iallocator script is not used).
759 Instead of specifying the nodes, an iallocator script can be used
760 to automatically compute them.
763 whether to start the instance
766 Skip the check for already-in-use instance; see the description in
767 the **add** command for details.
770 Skip the name check for instances; see the description in the
771 **add** command for details.
773 file\_storage\_dir, file\_driver
774 Configuration for the file disk type, see the **add** command for
778 A simple definition for one instance can be (with most of the
779 parameters taken from the cluster defaults)::
785 "disk_size": ["25G"],
791 "disk_size": ["25G"],
792 "iallocator": "dumb",
793 "hypervisor": "xen-hvm",
794 "hvparams": {"acpi": true},
795 "backend": {"maxmem": 512, "minmem": 256}
799 The command will display the job id for each submitted instance, as
802 # gnt-instance batch-create instances.json
809 **remove** [\--ignore-failures] [\--shutdown-timeout=*N*] [\--submit]
810 [\--force] {*instance*}
812 Remove an instance. This will remove all data from the instance and
813 there is *no way back*. If you are not sure if you use an instance
814 again, use **shutdown** first and leave it in the shutdown state for a
817 The ``--ignore-failures`` option will cause the removal to proceed
818 even in the presence of errors during the removal of the instance
819 (e.g. during the shutdown or the disk removal). If this option is not
820 given, the command will stop at the first error.
822 The ``--shutdown-timeout`` is used to specify how much time to wait
823 before forcing the shutdown (e.g. ``xm destroy`` in Xen, killing the
824 kvm process for KVM, etc.). By default two minutes are given to each
827 The ``--force`` option is used to skip the interactive confirmation.
829 See **ganeti(7)** for a description of ``--submit`` and other common
834 # gnt-instance remove instance1.example.com
841 | [\--no-headers] [\--separator=*SEPARATOR*] [\--units=*UNITS*] [-v]
842 | [{-o|\--output} *[+]FIELD,...*] [\--filter] [instance...]
844 Shows the currently configured instances with memory usage, disk
845 usage, the node they are running on, and their run status.
847 The ``--no-headers`` option will skip the initial header line. The
848 ``--separator`` option takes an argument which denotes what will be
849 used between the output fields. Both these options are to help
852 The units used to display the numeric values in the output varies,
853 depending on the options given. By default, the values will be
854 formatted in the most appropriate unit. If the ``--separator`` option
855 is given, then the values are shown in mebibytes to allow parsing by
856 scripts. In both cases, the ``--units`` option can be used to enforce
859 The ``-v`` option activates verbose mode, which changes the display of
860 special field states (see **ganeti(7)**).
862 The ``-o (--output)`` option takes a comma-separated list of output
863 fields. The available fields and their meaning are:
865 @QUERY_FIELDS_INSTANCE@
867 If the value of the option starts with the character ``+``, the new
868 field(s) will be added to the default list. This allows one to quickly
869 see the default list plus a few other fields, instead of retyping the
870 entire list of fields.
872 There is a subtle grouping about the available output fields: all
873 fields except for ``oper_state``, ``oper_ram``, ``oper_vcpus`` and
874 ``status`` are configuration value and not run-time values. So if you
875 don't select any of the these fields, the query will be satisfied
876 instantly from the cluster configuration, without having to ask the
877 remote nodes for the data. This can be helpful for big clusters when
878 you only want some data and it makes sense to specify a reduced set of
881 If exactly one argument is given and it appears to be a query filter
882 (see **ganeti(7)**), the query result is filtered accordingly. For
883 ambiguous cases (e.g. a single field name as a filter) the ``--filter``
884 (``-F``) option forces the argument to be treated as a filter (e.g.
885 ``gnt-instance list -F admin_state``).
887 The default output field list is: ``name``, ``os``, ``pnode``,
888 ``admin_state``, ``oper_state``, ``oper_ram``.
894 **list-fields** [field...]
896 Lists available fields for instances.
902 **info** [-s \| \--static] [\--roman] {\--all \| *instance*}
904 Show detailed information about the given instance(s). This is
905 different from **list** as it shows detailed data about the instance's
906 disks (especially useful for the drbd disk template).
908 If the option ``-s`` is used, only information available in the
909 configuration file is returned, without querying nodes, making the
912 Use the ``--all`` to get info about all instances, rather than
913 explicitly passing the ones you're interested in.
915 The ``--roman`` option can be used to cause envy among people who like
916 ancient cultures, but are stuck with non-latin-friendly cluster
917 virtualization technologies.
923 | [{-H|\--hypervisor-parameters} *HYPERVISOR\_PARAMETERS*]
924 | [{-B|\--backend-parameters} *BACKEND\_PARAMETERS*]
925 | [{-m|\--runtime-memory} *SIZE*]
926 | [\--net add*[:options]* \| \--net [*N*:]remove \| \--net *N:options*]
927 | [\--disk add:size=*SIZE*[,vg=*VG*][,metavg=*VG*] \| \--disk [*N*:]remove \|
928 | \--disk *N*:mode=*MODE*]
929 | [{-t|\--disk-template} plain | {-t|\--disk-template} drbd -n *new_secondary*] [\--no-wait-for-sync]
930 | [\--os-type=*OS* [\--force-variant]]
931 | [{-O|\--os-parameters} *param*=*value*... ]
932 | [\--offline \| \--online]
934 | [\--ignore-ipolicy]
937 Modifies the memory size, number of vcpus, ip address, MAC address
938 and/or nic parameters for an instance. It can also add and remove
939 disks and NICs to/from the instance. Note that you need to give at
940 least one of the arguments, otherwise the command complains.
942 The ``-H (--hypervisor-parameters)``, ``-B (--backend-parameters)``
943 and ``-O (--os-parameters)`` options specifies hypervisor, backend and
944 OS parameter options in the form of name=value[,...]. For details
945 which options can be specified, see the **add** command.
947 The ``-t (--disk-template)`` option will change the disk template of
948 the instance. Currently only conversions between the plain and drbd
949 disk templates are supported, and the instance must be stopped before
950 attempting the conversion. When changing from the plain to the drbd
951 disk template, a new secondary node must be specified via the ``-n``
952 option. The option ``--no-wait-for-sync`` can be used when converting
953 to the ``drbd`` template in order to make the instance available for
954 startup before DRBD has finished resyncing.
956 The ``-m (--runtime-memory)`` option will change an instance's runtime
957 memory to the given size (in MB if a different suffix is not specified),
958 by ballooning it up or down to the new value.
960 The ``--disk add:size=``*SIZE* option adds a disk to the instance. The
961 optional ``vg=``*VG* option specifies an LVM volume group other than
962 the default volume group to create the disk on. For DRBD disks, the
963 ``metavg=``*VG* option specifies the volume group for the metadata
964 device. ``--disk`` *N*``:add,size=``**SIZE** can be used to add a
965 disk at a specific index. The ``--disk remove`` option will remove the
966 last disk of the instance. Use ``--disk `` *N*``:remove`` to remove a
967 disk by its index. The ``--disk`` *N*``:mode=``*MODE* option will change
968 the mode of the Nth disk of the instance between read-only (``ro``) and
971 The ``--net add:``*options* and ``--net`` *N*``:add,``*options* option
972 will add a new network interface to the instance. The available options
973 are the same as in the **add** command (``mac``, ``ip``, ``link``,
974 ``mode``). The ``--net remove`` will remove the last network interface
975 of the instance (``--net`` *N*``:remove`` for a specific index), while
976 the ``--net`` *N*``:``*options* option will change the parameters of the Nth
977 instance network interface.
979 The option ``-o (--os-type)`` will change the OS name for the instance
980 (without reinstallation). In case an OS variant is specified that is
981 not found, then by default the modification is refused, unless
982 ``--force-variant`` is passed. An invalid OS will also be refused,
983 unless the ``--force`` option is given.
985 The ``--online`` and ``--offline`` options are used to transition an
986 instance into and out of the ``offline`` state. An instance can be
987 turned offline only if it was previously down. The ``--online`` option
988 fails if the instance was not in the ``offline`` state, otherwise it
989 changes instance's state to ``down``. These modifications take effect
992 If ``--ignore-ipolicy`` is given any instance policy violations occuring
993 during this operation are ignored.
995 See **ganeti(7)** for a description of ``--submit`` and other common
998 Most of the changes take effect at the next restart. If the instance is
999 running, there is no effect on the instance.
1004 | **reinstall** [{-o|\--os-type} *os-type*] [\--select-os] [-f *force*]
1005 | [\--force-multiple]
1006 | [\--instance \| \--node \| \--primary \| \--secondary \| \--all]
1007 | [{-O|\--os-parameters} *OS\_PARAMETERS*] [\--submit] {*instance*...}
1009 Reinstalls the operating system on the given instance(s). The
1010 instance(s) must be stopped when running this command. If the ``-o
1011 (--os-type)`` is specified, the operating system is changed.
1013 The ``--select-os`` option switches to an interactive OS reinstall.
1014 The user is prompted to select the OS template from the list of
1015 available OS templates. OS parameters can be overridden using ``-O
1016 (--os-parameters)`` (more documentation for this option under the
1019 Since this is a potentially dangerous command, the user will be
1020 required to confirm this action, unless the ``-f`` flag is passed.
1021 When multiple instances are selected (either by passing multiple
1022 arguments or by using the ``--node``, ``--primary``, ``--secondary``
1023 or ``--all`` options), the user must pass the ``--force-multiple``
1024 options to skip the interactive confirmation.
1026 See **ganeti(7)** for a description of ``--submit`` and other common
1032 | **rename** [\--no-ip-check] [\--no-name-check] [\--submit]
1033 | {*instance*} {*new\_name*}
1035 Renames the given instance. The instance must be stopped when running
1036 this command. The requirements for the new name are the same as for
1037 adding an instance: the new name must be resolvable and the IP it
1038 resolves to must not be reachable (in order to prevent duplicate IPs
1039 the next time the instance is started). The IP test can be skipped if
1040 the ``--no-ip-check`` option is passed.
1042 The ``--no-name-check`` skips the check for the new instance name via
1043 the resolver (e.g. in DNS or /etc/hosts, depending on your setup) and
1044 that the resolved name matches the provided name. Since the name check
1045 is used to compute the IP address, if you pass this option you must also
1046 pass the ``--no-ip-check`` option.
1048 See **ganeti(7)** for a description of ``--submit`` and other common
1051 Starting/stopping/connecting to console
1052 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1058 | [\--force] [\--ignore-offline]
1059 | [\--force-multiple] [\--no-remember]
1060 | [\--instance \| \--node \| \--primary \| \--secondary \| \--all \|
1061 | \--tags \| \--node-tags \| \--pri-node-tags \| \--sec-node-tags]
1062 | [{-H|\--hypervisor-parameters} ``key=value...``]
1063 | [{-B|\--backend-parameters} ``key=value...``]
1064 | [\--submit] [\--paused]
1067 Starts one or more instances, depending on the following options. The
1068 four available modes are:
1071 will start the instances given as arguments (at least one argument
1072 required); this is the default selection
1075 will start the instances who have the given node as either primary
1079 will start all instances whose primary node is in the list of nodes
1080 passed as arguments (at least one node required)
1083 will start all instances whose secondary node is in the list of
1084 nodes passed as arguments (at least one node required)
1087 will start all instances in the cluster (no arguments accepted)
1090 will start all instances in the cluster with the tags given as
1094 will start all instances in the cluster on nodes with the tags
1098 will start all instances in the cluster on primary nodes with the
1099 tags given as arguments
1102 will start all instances in the cluster on secondary nodes with the
1103 tags given as arguments
1105 Note that although you can pass more than one selection option, the
1106 last one wins, so in order to guarantee the desired result, don't pass
1107 more than one such option.
1109 Use ``--force`` to start even if secondary disks are failing.
1110 ``--ignore-offline`` can be used to ignore offline primary nodes and
1111 mark the instance as started even if the primary is not available.
1113 The ``--force-multiple`` will skip the interactive confirmation in the
1114 case the more than one instance will be affected.
1116 The ``--no-remember`` option will perform the startup but not change
1117 the state of the instance in the configuration file (if it was stopped
1118 before, Ganeti will still think it needs to be stopped). This can be
1119 used for testing, or for a one shot-start where you don't want the
1120 watcher to restart the instance if it crashes.
1122 The ``-H (--hypervisor-parameters)`` and ``-B (--backend-parameters)``
1123 options specify temporary hypervisor and backend parameters that can
1124 be used to start an instance with modified parameters. They can be
1125 useful for quick testing without having to modify an instance back and
1128 # gnt-instance start -H kernel_args="single" instance1
1129 # gnt-instance start -B maxmem=2048 instance2
1132 The first form will start the instance instance1 in single-user mode,
1133 and the instance instance2 with 2GB of RAM (this time only, unless
1134 that is the actual instance memory size already). Note that the values
1135 override the instance parameters (and not extend them): an instance
1136 with "kernel\_args=ro" when started with -H kernel\_args=single will
1137 result in "single", not "ro single".
1139 The ``--paused`` option is only valid for Xen and kvm hypervisors. This
1140 pauses the instance at the start of bootup, awaiting ``gnt-instance
1141 console`` to unpause it, allowing the entire boot process to be
1142 monitored for debugging.
1144 See **ganeti(7)** for a description of ``--submit`` and other common
1149 # gnt-instance start instance1.example.com
1150 # gnt-instance start --node node1.example.com node2.example.com
1151 # gnt-instance start --all
1159 | [\--force-multiple] [\--ignore-offline] [\--no-remember]
1160 | [\--instance \| \--node \| \--primary \| \--secondary \| \--all \|
1161 | \--tags \| \--node-tags \| \--pri-node-tags \| \--sec-node-tags]
1165 Stops one or more instances. If the instance cannot be cleanly stopped
1166 during a hardcoded interval (currently 2 minutes), it will forcibly
1167 stop the instance (equivalent to switching off the power on a physical
1170 The ``--timeout`` is used to specify how much time to wait before
1171 forcing the shutdown (e.g. ``xm destroy`` in Xen, killing the kvm
1172 process for KVM, etc.). By default two minutes are given to each
1175 The ``--instance``, ``--node``, ``--primary``, ``--secondary``,
1176 ``--all``, ``--tags``, ``--node-tags``, ``--pri-node-tags`` and
1177 ``--sec-node-tags`` options are similar as for the **startup** command
1178 and they influence the actual instances being shutdown.
1180 ``--ignore-offline`` can be used to ignore offline primary nodes and
1181 force the instance to be marked as stopped. This option should be used
1182 with care as it can lead to an inconsistent cluster state.
1184 The ``--no-remember`` option will perform the shutdown but not change
1185 the state of the instance in the configuration file (if it was running
1186 before, Ganeti will still thinks it needs to be running). This can be
1187 useful for a cluster-wide shutdown, where some instances are marked as
1188 up and some as down, and you don't want to change the running state:
1189 you just need to disable the watcher, shutdown all instances with
1190 ``--no-remember``, and when the watcher is activated again it will
1191 restore the correct runtime state for all instances.
1193 See **ganeti(7)** for a description of ``--submit`` and other common
1198 # gnt-instance shutdown instance1.example.com
1199 # gnt-instance shutdown --all
1206 | [{-t|\--type} *REBOOT-TYPE*]
1207 | [\--ignore-secondaries]
1208 | [\--shutdown-timeout=*N*]
1209 | [\--force-multiple]
1210 | [\--instance \| \--node \| \--primary \| \--secondary \| \--all \|
1211 | \--tags \| \--node-tags \| \--pri-node-tags \| \--sec-node-tags]
1215 Reboots one or more instances. The type of reboot depends on the value
1216 of ``-t (--type)``. A soft reboot does a hypervisor reboot, a hard reboot
1217 does a instance stop, recreates the hypervisor config for the instance
1218 and starts the instance. A full reboot does the equivalent of
1219 **gnt-instance shutdown && gnt-instance startup**. The default is
1222 For the hard reboot the option ``--ignore-secondaries`` ignores errors
1223 for the secondary node while re-assembling the instance disks.
1225 The ``--instance``, ``--node``, ``--primary``, ``--secondary``,
1226 ``--all``, ``--tags``, ``--node-tags``, ``--pri-node-tags`` and
1227 ``--sec-node-tags`` options are similar as for the **startup** command
1228 and they influence the actual instances being rebooted.
1230 The ``--shutdown-timeout`` is used to specify how much time to wait
1231 before forcing the shutdown (xm destroy in xen, killing the kvm
1232 process, for kvm). By default two minutes are given to each instance
1235 The ``--force-multiple`` will skip the interactive confirmation in the
1236 case the more than one instance will be affected.
1238 See **ganeti(7)** for a description of ``--submit`` and other common
1243 # gnt-instance reboot instance1.example.com
1244 # gnt-instance reboot --type=full instance1.example.com
1250 **console** [\--show-cmd] {*instance*}
1252 Connects to the console of the given instance. If the instance is not
1253 up, an error is returned. Use the ``--show-cmd`` option to display the
1254 command instead of executing it.
1256 For HVM instances, this will attempt to connect to the serial console
1257 of the instance. To connect to the virtualized "physical" console of a
1258 HVM instance, use a VNC client with the connection info from the
1261 For Xen/kvm instances, if the instance is paused, this attempts to
1262 unpause the instance after waiting a few seconds for the connection to
1263 the console to be made.
1267 # gnt-instance console instance1.example.com
1276 **replace-disks** [\--submit] [\--early-release] [\--ignore-ipolicy] {-p}
1277 [\--disks *idx*] {*instance*}
1279 **replace-disks** [\--submit] [\--early-release] [\--ignore-ipolicy] {-s}
1280 [\--disks *idx*] {*instance*}
1282 **replace-disks** [\--submit] [\--early-release] [\--ignore-ipolicy]
1283 {{-I\|\--iallocator} *name* \| {{-n|\--new-secondary} *node* } {*instance*}
1285 **replace-disks** [\--submit] [\--early-release] [\--ignore-ipolicy]
1286 {-a\|\--auto} {*instance*}
1288 This command is a generalized form for replacing disks. It is
1289 currently only valid for the mirrored (DRBD) disk template.
1291 The first form (when passing the ``-p`` option) will replace the disks
1292 on the primary, while the second form (when passing the ``-s`` option
1293 will replace the disks on the secondary node. For these two cases (as
1294 the node doesn't change), it is possible to only run the replace for a
1295 subset of the disks, using the option ``--disks`` which takes a list
1296 of comma-delimited disk indices (zero-based), e.g. 0,2 to replace only
1297 the first and third disks.
1299 The third form (when passing either the ``--iallocator`` or the
1300 ``--new-secondary`` option) is designed to change secondary node of the
1301 instance. Specifying ``--iallocator`` makes the new secondary be
1302 selected automatically by the specified allocator plugin (use ``.`` to
1303 indicate the default allocator), otherwise the new secondary node will
1304 be the one chosen manually via the ``--new-secondary`` option.
1306 Note that it is not possible to select an offline or drained node as a
1309 The fourth form (when using ``--auto``) will automatically determine
1310 which disks of an instance are faulty and replace them within the same
1311 node. The ``--auto`` option works only when an instance has only
1312 faulty disks on either the primary or secondary node; it doesn't work
1313 when both sides have faulty disks.
1315 The ``--early-release`` changes the code so that the old storage on
1316 secondary node(s) is removed early (before the resync is completed)
1317 and the internal Ganeti locks for the current (and new, if any)
1318 secondary node are also released, thus allowing more parallelism in
1319 the cluster operation. This should be used only when recovering from a
1320 disk failure on the current secondary (thus the old storage is already
1321 broken) or when the storage on the primary node is known to be fine
1322 (thus we won't need the old storage for potential recovery).
1324 The ``--ignore-ipolicy`` let the command ignore instance policy
1325 violations if replace-disks changes groups and the instance would
1326 violate the new groups instance policy.
1328 See **ganeti(7)** for a description of ``--submit`` and other common
1334 **activate-disks** [\--submit] [\--ignore-size] [\--wait-for-sync] {*instance*}
1336 Activates the block devices of the given instance. If successful, the
1337 command will show the location and name of the block devices::
1339 node1.example.com:disk/0:/dev/drbd0
1340 node1.example.com:disk/1:/dev/drbd1
1343 In this example, *node1.example.com* is the name of the node on which
1344 the devices have been activated. The *disk/0* and *disk/1* are the
1345 Ganeti-names of the instance disks; how they are visible inside the
1346 instance is hypervisor-specific. */dev/drbd0* and */dev/drbd1* are the
1347 actual block devices as visible on the node.
1349 The ``--ignore-size`` option can be used to activate disks ignoring
1350 the currently configured size in Ganeti. This can be used in cases
1351 where the configuration has gotten out of sync with the real-world
1352 (e.g. after a partially-failed grow-disk operation or due to rounding
1353 in LVM devices). This should not be used in normal cases, but only
1354 when activate-disks fails without it.
1356 The ``--wait-for-sync`` option will ensure that the command returns only
1357 after the instance's disks are synchronised (mostly for DRBD); this can
1358 be useful to ensure consistency, as otherwise there are no commands that
1359 can wait until synchronisation is done. However when passing this
1360 option, the command will have additional output, making it harder to
1361 parse the disk information.
1363 Note that it is safe to run this command while the instance is already
1366 See **ganeti(7)** for a description of ``--submit`` and other common
1372 **deactivate-disks** [-f] [\--submit] {*instance*}
1374 De-activates the block devices of the given instance. Note that if you
1375 run this command for an instance with a drbd disk template, while it
1376 is running, it will not be able to shutdown the block devices on the
1377 primary node, but it will shutdown the block devices on the secondary
1378 nodes, thus breaking the replication.
1380 The ``-f``/``--force`` option will skip checks that the instance is
1381 down; in case the hypervisor is confused and we can't talk to it,
1382 normally Ganeti will refuse to deactivate the disks, but with this
1383 option passed it will skip this check and directly try to deactivate
1384 the disks. This can still fail due to the instance actually running or
1387 See **ganeti(7)** for a description of ``--submit`` and other common
1393 | **grow-disk** [\--no-wait-for-sync] [\--submit] [\--absolute]
1394 | {*instance*} {*disk*} {*amount*}
1396 Grows an instance's disk. This is only possible for instances having a
1397 plain, drbd or rbd disk template.
1399 Note that this command only change the block device size; it will not
1400 grow the actual filesystems, partitions, etc. that live on that
1401 disk. Usually, you will need to:
1403 #. use **gnt-instance grow-disk**
1405 #. reboot the instance (later, at a convenient time)
1407 #. use a filesystem resizer, such as ext2online(8) or
1408 xfs\_growfs(8) to resize the filesystem, or use fdisk(8) to change
1409 the partition table on the disk
1411 The *disk* argument is the index of the instance disk to grow. The
1412 *amount* argument is given as a number which can have a suffix (like the
1413 disk size in instance create); if the suffix is missing, the value will
1414 be interpreted as mebibytes.
1416 By default, the *amount* value represents the desired increase in the
1417 disk size (e.g. an amount of 1G will take a disk of size 3G to 4G). If
1418 the optional ``--absolute`` parameter is passed, then the *amount*
1419 argument doesn't represent the delta, but instead the desired final disk
1420 size (e.g. an amount of 8G will take a disk of size 4G to 8G).
1422 For instances with a drbd template, note that the disk grow operation
1423 might complete on one node but fail on the other; this will leave the
1424 instance with different-sized LVs on the two nodes, but this will not
1425 create problems (except for unused space).
1427 If you do not want gnt-instance to wait for the new disk region to be
1428 synced, use the ``--no-wait-for-sync`` option.
1430 See **ganeti(7)** for a description of ``--submit`` and other common
1433 Example (increase the first disk for instance1 by 16GiB)::
1435 # gnt-instance grow-disk instance1.example.com 0 16g
1437 Example for increasing the disk size to a certain size::
1439 # gnt-instance grow-disk --absolute instance1.example.com 0 32g
1441 Also note that disk shrinking is not supported; use **gnt-backup
1442 export** and then **gnt-backup import** to reduce the disk size of an
1448 | **recreate-disks** [\--submit]
1449 | [{-n node1:[node2] \| {-I\|\--iallocator *name*}}]
1450 | [\--disk=*N*[:[size=*VAL*][,mode=*ro\|rw*]]] {*instance*}
1452 Recreates all or a subset of disks of the given instance.
1454 Note that this functionality should only be used for missing disks; if
1455 any of the given disks already exists, the operation will fail. While
1456 this is suboptimal, recreate-disks should hopefully not be needed in
1457 normal operation and as such the impact of this is low.
1459 If only a subset should be recreated, any number of ``disk`` options can
1460 be specified. It expects a disk index and an optional list of disk
1461 parameters to change. Only ``size`` and ``mode`` can be changed while
1462 recreating disks. To recreate all disks while changing parameters on
1463 a subset only, a ``--disk`` option must be given for every disk of the
1466 Optionally the instance's disks can be recreated on different
1467 nodes. This can be useful if, for example, the original nodes of the
1468 instance have gone down (and are marked offline), so we can't recreate
1469 on the same nodes. To do this, pass the new node(s) via ``-n`` option,
1470 with a syntax similar to the **add** command. The number of nodes
1471 passed must equal the number of nodes that the instance currently
1472 has. Note that changing nodes is only allowed when all disks are
1473 replaced, e.g. when no ``--disk`` option is passed.
1475 Another method of choosing which nodes to place the instance on is by
1476 using the specified iallocator, passing the ``--iallocator`` option.
1477 The primary and secondary nodes will be chosen by the specified
1478 iallocator plugin, or by the default allocator if ``.`` is specified.
1480 See **ganeti(7)** for a description of ``--submit`` and other common
1489 | **failover** [-f] [\--ignore-consistency] [\--ignore-ipolicy]
1490 | [\--shutdown-timeout=*N*]
1491 | [{-n|\--target-node} *node* \| {-I|\--iallocator} *name*]
1495 Failover will stop the instance (if running), change its primary node,
1496 and if it was originally running it will start it again (on the new
1497 primary). This only works for instances with drbd template (in which
1498 case you can only fail to the secondary node) and for externally
1499 mirrored templates (blockdev and rbd) (which can change to any other
1502 If the instance's disk template is of type blockdev or rbd, then you
1503 can explicitly specify the target node (which can be any node) using
1504 the ``-n`` or ``--target-node`` option, or specify an iallocator plugin
1505 using the ``-I`` or ``--iallocator`` option. If you omit both, the default
1506 iallocator will be used to specify the target node.
1508 Normally the failover will check the consistency of the disks before
1509 failing over the instance. If you are trying to migrate instances off
1510 a dead node, this will fail. Use the ``--ignore-consistency`` option
1511 for this purpose. Note that this option can be dangerous as errors in
1512 shutting down the instance will be ignored, resulting in possibly
1513 having the instance running on two machines in parallel (on
1514 disconnected DRBD drives).
1516 The ``--shutdown-timeout`` is used to specify how much time to wait
1517 before forcing the shutdown (xm destroy in xen, killing the kvm
1518 process, for kvm). By default two minutes are given to each instance
1521 If ``--ignore-ipolicy`` is given any instance policy violations occuring
1522 during this operation are ignored.
1524 See **ganeti(7)** for a description of ``--submit`` and other common
1529 # gnt-instance failover instance1.example.com
1535 | **migrate** [-f] [\--allow-failover] [\--non-live]
1536 | [\--migration-mode=live\|non-live] [\--ignore-ipolicy]
1537 | [\--no-runtime-changes] [\--submit]
1538 | [{-n|\--target-node} *node* \| {-I|\--iallocator} *name*] {*instance*}
1540 | **migrate** [-f] \--cleanup [\--submit] {*instance*}
1542 Migrate will move the instance to its secondary node without shutdown.
1543 As with failover, it only works for instances having the drbd disk
1544 template or an externally mirrored disk template type such as blockdev
1547 If the instance's disk template is of type blockdev or rbd, then you can
1548 explicitly specify the target node (which can be any node) using the
1549 ``-n`` or ``--target-node`` option, or specify an iallocator plugin
1550 using the ``-I`` or ``--iallocator`` option. If you omit both, the
1551 default iallocator will be used to specify the target node.
1552 Alternatively, the default iallocator can be requested by specifying
1553 ``.`` as the name of the plugin.
1555 The migration command needs a perfectly healthy instance, as we rely
1556 on the dual-master capability of drbd8 and the disks of the instance
1557 are not allowed to be degraded.
1559 The ``--non-live`` and ``--migration-mode=non-live`` options will
1560 switch (for the hypervisors that support it) between a "fully live"
1561 (i.e. the interruption is as minimal as possible) migration and one in
1562 which the instance is frozen, its state saved and transported to the
1563 remote node, and then resumed there. This all depends on the
1564 hypervisor support for two different methods. In any case, it is not
1565 an error to pass this parameter (it will just be ignored if the
1566 hypervisor doesn't support it). The option ``--migration-mode=live``
1567 option will request a fully-live migration. The default, when neither
1568 option is passed, depends on the hypervisor parameters (and can be
1569 viewed with the **gnt-cluster info** command).
1571 If the ``--cleanup`` option is passed, the operation changes from
1572 migration to attempting recovery from a failed previous migration. In
1573 this mode, Ganeti checks if the instance runs on the correct node (and
1574 updates its configuration if not) and ensures the instances' disks
1575 are configured correctly. In this mode, the ``--non-live`` option is
1578 The option ``-f`` will skip the prompting for confirmation.
1580 If ``--allow-failover`` is specified it tries to fallback to failover if
1581 it already can determine that a migration won't work (e.g. if the
1582 instance is shut down). Please note that the fallback will not happen
1583 during execution. If a migration fails during execution it still fails.
1585 If ``--ignore-ipolicy`` is given any instance policy violations occuring
1586 during this operation are ignored.
1588 The ``--no-runtime-changes`` option forbids migrate to alter an
1589 instance's runtime before migrating it (eg. ballooning an instance
1590 down because the target node doesn't have enough available memory).
1592 If an instance has the backend parameter ``always\_failover`` set to
1593 true, then the migration is automatically converted into a failover.
1595 See **ganeti(7)** for a description of ``--submit`` and other common
1598 Example (and expected output)::
1600 # gnt-instance migrate instance1
1601 Instance instance1 will be migrated. Note that migration
1602 might impact the instance if anything goes wrong (e.g. due to bugs in
1603 the hypervisor). Continue?
1605 Migrating instance instance1.example.com
1606 * checking disk consistency between source and target
1607 * switching node node2.example.com to secondary mode
1608 * changing into standalone mode
1609 * changing disks into dual-master mode
1610 * wait until resync is done
1611 * preparing node2.example.com to accept the instance
1612 * migrating instance to node2.example.com
1613 * switching node node1.example.com to secondary mode
1614 * wait until resync is done
1615 * changing into standalone mode
1616 * changing disks into single-master mode
1617 * wait until resync is done
1625 | **move** [-f] [\--ignore-consistency]
1626 | [-n *node*] [\--shutdown-timeout=*N*] [\--submit] [\--ignore-ipolicy]
1629 Move will move the instance to an arbitrary node in the cluster. This
1630 works only for instances having a plain or file disk template.
1632 Note that since this operation is done via data copy, it will take a
1633 long time for big disks (similar to replace-disks for a drbd
1636 The ``--shutdown-timeout`` is used to specify how much time to wait
1637 before forcing the shutdown (e.g. ``xm destroy`` in XEN, killing the
1638 kvm process for KVM, etc.). By default two minutes are given to each
1641 The ``--ignore-consistency`` option will make Ganeti ignore any errors
1642 in trying to shutdown the instance on its node; useful if the
1643 hypervisor is broken and you want to recuperate the data.
1645 If ``--ignore-ipolicy`` is given any instance policy violations occuring
1646 during this operation are ignored.
1648 See **ganeti(7)** for a description of ``--submit`` and other common
1653 # gnt-instance move -n node3.example.com instance1.example.com
1659 | **change-group** [\--submit]
1660 | [\--iallocator *NAME*] [\--to *GROUP*...] {*instance*}
1662 This command moves an instance to another node group. The move is
1663 calculated by an iallocator, either given on the command line or as a
1666 If no specific destination groups are specified using ``--to``, all
1667 groups except the one containing the instance are considered.
1669 See **ganeti(7)** for a description of ``--submit`` and other common
1674 # gnt-instance change-group -I hail --to rack2 inst1.example.com
1683 **add-tags** [\--from *file*] {*instancename*} {*tag*...}
1685 Add tags to the given instance. If any of the tags contains invalid
1686 characters, the entire operation will abort.
1688 If the ``--from`` option is given, the list of tags will be extended
1689 with the contents of that file (each line becomes a tag). In this
1690 case, there is not need to pass tags on the command line (if you do,
1691 both sources will be used). A file name of ``-`` will be interpreted
1697 **list-tags** {*instancename*}
1699 List the tags of the given instance.
1704 **remove-tags** [\--from *file*] {*instancename*} {*tag*...}
1706 Remove tags from the given instance. If any of the tags are not
1707 existing on the node, the entire operation will abort.
1709 If the ``--from`` option is given, the list of tags to be removed will
1710 be extended with the contents of that file (each line becomes a tag).
1711 In this case, there is not need to pass tags on the command line (if
1712 you do, tags from both sources will be removed). A file name of ``-``
1713 will be interpreted as stdin.
1715 .. vim: set textwidth=72 :