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 wat 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
194 netboot from virtio interfaces. This has been fixed in more recent
195 versions and is confirmed to work at least with qemu-kvm 0.11.1.
198 Valid for the Xen HVM and PVM hypervisors.
200 Relevant to non-pvops guest kernels, in which the disk device names
201 are given by the host. Allows one to specify 'xvd', which helps run
202 Red Hat based installers, driven by anaconda.
205 Valid for the KVM hypervisor.
207 The path to a floppy disk image to attach to the instance. This
208 is useful to install Windows operating systems on Virt/IO disks
209 because you can specify here the floppy for the drivers at
213 Valid for the Xen HVM and KVM hypervisors.
215 The path to a CDROM image to attach to the instance.
218 Valid for the KVM hypervisor.
220 The path to a second CDROM image to attach to the instance.
221 **NOTE**: This image can't be used to boot the system. To do that
222 you have to use the 'cdrom\_image\_path' option.
225 Valid for the Xen HVM and KVM hypervisors.
227 This parameter determines the way the network cards are presented
228 to the instance. The possible options are:
230 - rtl8139 (default for Xen HVM) (HVM & KVM)
231 - ne2k\_isa (HVM & KVM)
232 - ne2k\_pci (HVM & KVM)
238 - paravirtual (default for KVM) (HVM & KVM)
241 Valid for the Xen HVM and KVM hypervisors.
243 This parameter determines the way the disks are presented to the
244 instance. The possible options are:
246 - ioemu [default] (HVM & KVM)
255 Valid for the KVM hypervisor.
257 This parameter determines the way the cdroms disks are presented
258 to the instance. The default behavior is to get the same value of
259 the eariler parameter (disk_type). The possible options are:
270 Valid for the Xen HVM and KVM hypervisors.
272 Specifies the address that the VNC listener for this instance
273 should bind to. Valid values are IPv4 addresses. Use the address
274 0.0.0.0 to bind to all available interfaces (this is the default)
275 or specify the address of one of the interfaces on the node to
276 restrict listening to that interface.
279 Valid for the KVM hypervisor.
281 A boolean option that controls whether the VNC connection is
285 Valid for the KVM hypervisor.
287 If ``vnc_tls`` is enabled, this options specifies the path to the
288 x509 certificate to use.
291 Valid for the KVM hypervisor.
294 Valid for the KVM hypervisor.
296 Specifies the address or interface on which the SPICE server will
297 listen. Valid values are:
299 - IPv4 addresses, including 0.0.0.0 and 127.0.0.1
300 - IPv6 addresses, including :: and ::1
301 - names of network interfaces
303 If a network interface is specified, the SPICE server will be bound
304 to one of the addresses of that interface.
307 Valid for the KVM hypervisor.
309 Specifies which version of the IP protocol should be used by the
312 It is mainly intended to be used for specifying what kind of IP
313 addresses should be used if a network interface with both IPv4 and
314 IPv6 addresses is specified via the ``spice_bind`` parameter. In
315 this case, if the ``spice_ip_version`` parameter is not used, the
316 default IP version of the cluster will be used.
318 spice\_password\_file
319 Valid for the KVM hypervisor.
321 Specifies a file containing the password that must be used when
322 connecting via the SPICE protocol. If the option is not specified,
323 passwordless connections are allowed.
325 spice\_image\_compression
326 Valid for the KVM hypervisor.
328 Configures the SPICE lossless image compression. Valid values are:
337 spice\_jpeg\_wan\_compression
338 Valid for the KVM hypervisor.
340 Configures how SPICE should use the jpeg algorithm for lossy image
341 compression on slow links. Valid values are:
347 spice\_zlib\_glz\_wan\_compression
348 Valid for the KVM hypervisor.
350 Configures how SPICE should use the zlib-glz algorithm for lossy image
351 compression on slow links. Valid values are:
357 spice\_streaming\_video
358 Valid for the KVM hypervisor.
360 Configures how SPICE should detect video streams. Valid values are:
366 spice\_playback\_compression
367 Valid for the KVM hypervisor.
369 Configures whether SPICE should compress audio streams or not.
372 Valid for the KVM hypervisor.
374 Specifies that the SPICE server must use TLS to encrypt all the
375 traffic with the client.
378 Valid for the KVM hypervisor.
380 Specifies a list of comma-separated ciphers that SPICE should use
381 for TLS connections. For the format, see man cipher(1).
384 Valid for the KVM hypervisor.
386 Enables or disables passing mouse events via SPICE vdagent.
389 Valid for the Xen HVM and KVM hypervisors.
391 A boolean option that specifies if the hypervisor should enable
392 ACPI support for this instance. By default, ACPI is disabled.
395 Valid for the Xen HVM and KVM hypervisors.
397 A boolean option that specifies if the hypervisor should enabled
398 PAE support for this instance. The default is false, disabling PAE
402 Valid for the Xen HVM and KVM hypervisors.
404 A boolean option that specifies if the instance should be started
405 with its clock set to the localtime of the machine (when true) or
406 to the UTC (When false). The default is false, which is useful for
407 Linux/Unix machines; for Windows OSes, it is recommended to enable
411 Valid for the Xen PVM and KVM hypervisors.
413 This option specifies the path (on the node) to the kernel to boot
414 the instance with. Xen PVM instances always require this, while
415 for KVM if this option is empty, it will cause the machine to load
416 the kernel from its disks.
419 Valid for the Xen PVM and KVM hypervisors.
421 This options specifies extra arguments to the kernel that will be
422 loaded. device. This is always used for Xen PVM, while for KVM it
423 is only used if the ``kernel_path`` option is also specified.
425 The default setting for this value is simply ``"ro"``, which
426 mounts the root disk (initially) in read-only one. For example,
427 setting this to single will cause the instance to start in
431 Valid for the Xen PVM and KVM hypervisors.
433 This option specifies the path (on the node) to the initrd to boot
434 the instance with. Xen PVM instances can use this always, while
435 for KVM if this option is only used if the ``kernel_path`` option
436 is also specified. You can pass here either an absolute filename
437 (the path to the initrd) if you want to use an initrd, or use the
438 format no\_initrd\_path for no initrd.
441 Valid for the Xen PVM and KVM hypervisors.
443 This options specifies the name of the root device. This is always
444 needed for Xen PVM, while for KVM it is only used if the
445 ``kernel_path`` option is also specified.
447 Please note, that if this setting is an empty string and the
448 hypervisor is Xen it will not be written to the Xen configuration
452 Valid for the KVM hypervisor.
454 This boolean option specifies whether to emulate a serial console
458 Valid for the KVM hypervisor.
460 The disk cache mode. It can be either default to not pass any
461 cache option to KVM, or one of the KVM cache modes: none (for
462 direct I/O), writethrough (to use the host cache but report
463 completion to the guest only when the host has committed the
464 changes to disk) or writeback (to use the host cache and report
465 completion as soon as the data is in the host cache). Note that
466 there are special considerations for the cache mode depending on
467 version of KVM used and disk type (always raw file under Ganeti),
468 please refer to the KVM documentation for more details.
471 Valid for the KVM hypervisor.
473 The security model for kvm. Currently one of *none*, *user* or
474 *pool*. Under *none*, the default, nothing is done and instances
475 are run as the Ganeti daemon user (normally root).
477 Under *user* kvm will drop privileges and become the user
478 specified by the security\_domain parameter.
480 Under *pool* a global cluster pool of users will be used, making
481 sure no two instances share the same user on the same node. (this
482 mode is not implemented yet)
485 Valid for the KVM hypervisor.
487 Under security model *user* the username to run the instance
488 under. It must be a valid username existing on the host.
490 Cannot be set under security model *none* or *pool*.
493 Valid for the KVM hypervisor.
495 If *enabled* the -enable-kvm flag is passed to kvm. If *disabled*
496 -disable-kvm is passed. If unset no flag is passed, and the
497 default running mode for your kvm binary will be used.
500 Valid for the KVM hypervisor.
502 This option passes the -mem-path argument to kvm with the path (on
503 the node) to the mount point of the hugetlbfs file system, along
504 with the -mem-prealloc argument too.
507 Valid for the KVM hypervisor.
509 This boolean option determines wether to run the KVM instance in a
512 If it is set to ``true``, an empty directory is created before
513 starting the instance and its path is passed via the -chroot flag
514 to kvm. The directory is removed when the instance is stopped.
516 It is set to ``false`` by default.
519 Valid for the KVM hypervisor.
521 The maximum amount of time (in ms) a KVM instance is allowed to be
522 frozen during a live migration, in order to copy dirty memory
523 pages. Default value is 30ms, but you may need to increase this
524 value for busy instances.
526 This option is only effective with kvm versions >= 87 and qemu-kvm
530 Valid for the Xen, KVM and LXC hypervisors.
532 The processes belonging to the given instance are only scheduled
533 on the specified CPUs.
535 The format of the mask can be given in three forms. First, the word
536 "all", which signifies the common case where all VCPUs can live on
537 any CPU, based on the hypervisor's decisions.
539 Second, a comma-separated list of CPU IDs or CPU ID ranges. The
540 ranges are defined by a lower and higher boundary, separated by a
541 dash, and the boundaries are inclusive. In this form, all VCPUs of
542 the instance will be mapped on the selected list of CPUs. Example:
543 ``0-2,5``, mapping all VCPUs (no matter how many) onto physical CPUs
546 The last form is used for explicit control of VCPU-CPU pinnings. In
547 this form, the list of VCPU mappings is given as a colon (:)
548 separated list, whose elements are the possible values for the
549 second or first form above. In this form, the number of elements in
550 the colon-separated list _must_ equal the number of VCPUs of the
555 # Map the entire instance to CPUs 0-2
556 gnt-instance modify -H cpu_mask=0-2 my-inst
558 # Map vCPU 0 to physical CPU 1 and vCPU 1 to CPU 3 (assuming 2 vCPUs)
559 gnt-instance modify -H cpu_mask=1:3 my-inst
561 # Pin vCPU 0 to CPUs 1 or 2, and vCPU 1 to any CPU
562 gnt-instance modify -H cpu_mask=1-2:all my-inst
564 # Pin vCPU 0 to any CPU, vCPU 1 to CPUs 1, 3, 4 or 5, and CPU 2 to
565 # CPU 0 (backslashes for escaping the comma)
566 gnt-instance modify -H cpu_mask=all:1\\,3-5:0 my-inst
568 # Pin entire VM to CPU 0
569 gnt-instance modify -H cpu_mask=0 my-inst
571 # Turn off CPU pinning (default setting)
572 gnt-instance modify -H cpu_mask=all my-inst
575 Valid for the KVM hypervisor.
577 This option specifies the usb mouse type to be used. It can be
578 "mouse" or "tablet". When using VNC it's recommended to set it to
582 Valid for the KVM hypervisor.
584 This option specifies the keyboard mapping to be used. It is only
585 needed when using the VNC console. For example: "fr" or "en-gb".
588 Valid for Xen PVM, Xen HVM and KVM hypervisors.
590 Normally if an instance reboots, the hypervisor will restart it. If
591 this option is set to ``exit``, the hypervisor will treat a reboot
592 as a shutdown instead.
594 It is set to ``reboot`` by default.
597 The ``-O (--os-parameters)`` option allows customisation of the OS
598 parameters. The actual parameter names and values depends on the OS
599 being used, but the syntax is the same key=value. For example, setting
600 a hypothetical ``dhcp`` parameter to yes can be achieved by::
602 gnt-instance add -O dhcp=yes ...
604 The ``-I (--iallocator)`` option specifies the instance allocator
605 plugin to use. If you pass in this option the allocator will select
606 nodes for this instance automatically, so you don't need to pass them
607 with the ``-n`` option. For more information please refer to the
608 instance allocator documentation.
610 The ``-t (--disk-template)`` options specifies the disk layout type
611 for the instance. The available choices are:
614 This creates an instance with no disks. Its useful for testing only
615 (or other special cases).
618 Disk devices will be regular files.
621 Disk devices will be logical volumes.
624 Disk devices will be drbd (version 8.x) on top of lvm volumes.
627 Disk devices will be rbd volumes residing inside a RADOS cluster.
630 The optional second value of the ``-n (--node)`` is used for the drbd
631 template type and specifies the remote node.
633 If you do not want gnt-instance to wait for the disk mirror to be
634 synced, use the ``--no-wait-for-sync`` option.
636 The ``--file-storage-dir`` specifies the relative path under the
637 cluster-wide file storage directory to store file-based disks. It is
638 useful for having different subdirectories for different
639 instances. The full path of the directory where the disk files are
640 stored will consist of cluster-wide file storage directory + optional
641 subdirectory + instance name. Example:
642 ``@RPL_FILE_STORAGE_DIR@``*/mysubdir/instance1.example.com*. This
643 option is only relevant for instances using the file storage backend.
645 The ``--file-driver`` specifies the driver to use for file-based
646 disks. Note that currently these drivers work with the xen hypervisor
647 only. This option is only relevant for instances using the file
648 storage backend. The available choices are:
651 Kernel loopback driver. This driver uses loopback devices to
652 access the filesystem within the file. However, running I/O
653 intensive applications in your instance using the loop driver
654 might result in slowdowns. Furthermore, if you use the loopback
655 driver consider increasing the maximum amount of loopback devices
656 (on most systems it's 8) using the max\_loop param.
659 The blktap driver (for Xen hypervisors). In order to be able to
660 use the blktap driver you should check if the 'blktapctrl' user
661 space disk agent is running (usually automatically started via
662 xend). This user-level disk I/O interface has the advantage of
663 better performance. Especially if you use a network file system
664 (e.g. NFS) to store your instances this is the recommended choice.
666 If ``--ignore-ipolicy`` is given any instance policy violations occuring
667 during this operation are ignored.
669 See **ganeti(7)** for a description of ``--submit`` and other common
674 # gnt-instance add -t file --disk 0:size=30g -B maxmem=512 -o debian-etch \
675 -n node1.example.com --file-storage-dir=mysubdir instance1.example.com
676 # gnt-instance add -t plain --disk 0:size=30g -B maxmem=1024,minmem=512 \
677 -o debian-etch -n node1.example.com instance1.example.com
678 # gnt-instance add -t plain --disk 0:size=30g --disk 1:size=100g,vg=san \
679 -B maxmem=512 -o debian-etch -n node1.example.com instance1.example.com
680 # gnt-instance add -t drbd --disk 0:size=30g -B maxmem=512 -o debian-etch \
681 -n node1.example.com:node2.example.com instance2.example.com
687 **batch-create** {instances\_file.json}
689 This command (similar to the Ganeti 1.2 **batcher** tool) submits
690 multiple instance creation jobs based on a definition file. The
691 instance configurations do not encompass all the possible options for
692 the **add** command, but only a subset.
694 The instance file should be a valid-formed JSON file, containing a
695 dictionary with instance name and instance parameters. The accepted
699 The size of the disks of the instance.
702 The disk template to use for the instance, the same as in the
706 A dictionary of backend parameters.
709 A dictionary with a single key (the hypervisor name), and as value
710 the hypervisor options. If not passed, the default hypervisor and
711 hypervisor options will be inherited.
714 Specifications for the one NIC that will be created for the
715 instance. 'bridge' is also accepted as a backwards compatibile
719 List of nics that will be created for the instance. Each entry
720 should be a dict, with mac, ip, mode and link as possible keys.
721 Please don't provide the "mac, ip, mode, link" parent keys if you
722 use this method for specifying nics.
724 primary\_node, secondary\_node
725 The primary and optionally the secondary node to use for the
726 instance (in case an iallocator script is not used).
729 Instead of specifying the nodes, an iallocator script can be used
730 to automatically compute them.
733 whether to start the instance
736 Skip the check for already-in-use instance; see the description in
737 the **add** command for details.
740 Skip the name check for instances; see the description in the
741 **add** command for details.
743 file\_storage\_dir, file\_driver
744 Configuration for the file disk type, see the **add** command for
748 A simple definition for one instance can be (with most of the
749 parameters taken from the cluster defaults)::
755 "disk_size": ["25G"],
761 "disk_size": ["25G"],
762 "iallocator": "dumb",
763 "hypervisor": "xen-hvm",
764 "hvparams": {"acpi": true},
765 "backend": {"maxmem": 512, "minmem": 256}
769 The command will display the job id for each submitted instance, as
772 # gnt-instance batch-create instances.json
779 **remove** [\--ignore-failures] [\--shutdown-timeout=*N*] [\--submit]
780 [\--force] {*instance*}
782 Remove an instance. This will remove all data from the instance and
783 there is *no way back*. If you are not sure if you use an instance
784 again, use **shutdown** first and leave it in the shutdown state for a
787 The ``--ignore-failures`` option will cause the removal to proceed
788 even in the presence of errors during the removal of the instance
789 (e.g. during the shutdown or the disk removal). If this option is not
790 given, the command will stop at the first error.
792 The ``--shutdown-timeout`` is used to specify how much time to wait
793 before forcing the shutdown (e.g. ``xm destroy`` in Xen, killing the
794 kvm process for KVM, etc.). By default two minutes are given to each
797 The ``--force`` option is used to skip the interactive confirmation.
799 See **ganeti(7)** for a description of ``--submit`` and other common
804 # gnt-instance remove instance1.example.com
811 | [\--no-headers] [\--separator=*SEPARATOR*] [\--units=*UNITS*] [-v]
812 | [{-o|\--output} *[+]FIELD,...*] [\--filter] [instance...]
814 Shows the currently configured instances with memory usage, disk
815 usage, the node they are running on, and their run status.
817 The ``--no-headers`` option will skip the initial header line. The
818 ``--separator`` option takes an argument which denotes what will be
819 used between the output fields. Both these options are to help
822 The units used to display the numeric values in the output varies,
823 depending on the options given. By default, the values will be
824 formatted in the most appropriate unit. If the ``--separator`` option
825 is given, then the values are shown in mebibytes to allow parsing by
826 scripts. In both cases, the ``--units`` option can be used to enforce
829 The ``-v`` option activates verbose mode, which changes the display of
830 special field states (see **ganeti(7)**).
832 The ``-o (--output)`` option takes a comma-separated list of output
833 fields. The available fields and their meaning are:
835 @QUERY_FIELDS_INSTANCE@
837 If the value of the option starts with the character ``+``, the new
838 field(s) will be added to the default list. This allows one to quickly
839 see the default list plus a few other fields, instead of retyping the
840 entire list of fields.
842 There is a subtle grouping about the available output fields: all
843 fields except for ``oper_state``, ``oper_ram``, ``oper_vcpus`` and
844 ``status`` are configuration value and not run-time values. So if you
845 don't select any of the these fields, the query will be satisfied
846 instantly from the cluster configuration, without having to ask the
847 remote nodes for the data. This can be helpful for big clusters when
848 you only want some data and it makes sense to specify a reduced set of
851 If exactly one argument is given and it appears to be a query filter
852 (see **ganeti(7)**), the query result is filtered accordingly. For
853 ambiguous cases (e.g. a single field name as a filter) the ``--filter``
854 (``-F``) option forces the argument to be treated as a filter (e.g.
855 ``gnt-instance list -F admin_state``).
857 The default output field list is: ``name``, ``os``, ``pnode``,
858 ``admin_state``, ``oper_state``, ``oper_ram``.
864 **list-fields** [field...]
866 Lists available fields for instances.
872 **info** [-s \| \--static] [\--roman] {\--all \| *instance*}
874 Show detailed information about the given instance(s). This is
875 different from **list** as it shows detailed data about the instance's
876 disks (especially useful for the drbd disk template).
878 If the option ``-s`` is used, only information available in the
879 configuration file is returned, without querying nodes, making the
882 Use the ``--all`` to get info about all instances, rather than
883 explicitly passing the ones you're interested in.
885 The ``--roman`` option can be used to cause envy among people who like
886 ancient cultures, but are stuck with non-latin-friendly cluster
887 virtualization technologies.
893 | [{-H|\--hypervisor-parameters} *HYPERVISOR\_PARAMETERS*]
894 | [{-B|\--backend-parameters} *BACKEND\_PARAMETERS*]
895 | [{-m|\--runtime-memory} *SIZE*]
896 | [\--net add*[:options]* \| \--net remove \| \--net *N:options*]
897 | [\--disk add:size=*SIZE*[,vg=*VG*][,metavg=*VG*] \| \--disk remove \|
898 | \--disk *N*:mode=*MODE*]
899 | [{-t|\--disk-template} plain | {-t|\--disk-template} drbd -n *new_secondary*] [\--no-wait-for-sync]
900 | [\--os-type=*OS* [\--force-variant]]
901 | [{-O|\--os-parameters} *param*=*value*... ]
902 | [\--offline \| \--online]
904 | [\--ignore-ipolicy]
907 Modifies the memory size, number of vcpus, ip address, MAC address
908 and/or nic parameters for an instance. It can also add and remove
909 disks and NICs to/from the instance. Note that you need to give at
910 least one of the arguments, otherwise the command complains.
912 The ``-H (--hypervisor-parameters)``, ``-B (--backend-parameters)``
913 and ``-O (--os-parameters)`` options specifies hypervisor, backend and
914 OS parameter options in the form of name=value[,...]. For details
915 which options can be specified, see the **add** command.
917 The ``-t (--disk-template)`` option will change the disk template of
918 the instance. Currently only conversions between the plain and drbd
919 disk templates are supported, and the instance must be stopped before
920 attempting the conversion. When changing from the plain to the drbd
921 disk template, a new secondary node must be specified via the ``-n``
922 option. The option ``--no-wait-for-sync`` can be used when converting
923 to the ``drbd`` template in order to make the instance available for
924 startup before DRBD has finished resyncing.
926 The ``-m (--runtime-memory)`` option will change an instance's runtime
927 memory to the given size (in MB if a different suffix is not specified),
928 by ballooning it up or down to the new value.
930 The ``--disk add:size=``*SIZE* option adds a disk to the instance. The
931 optional ``vg=``*VG* option specifies an LVM volume group other than
932 the default volume group to create the disk on. For DRBD disks, the
933 ``metavg=``*VG* option specifies the volume group for the metadata
934 device. ``--disk`` *N*``:add,size=``**SIZE** can be used to add a
935 disk at a specific index. The ``--disk remove`` option will remove the
936 last disk of the instance. Use ``--disk `` *N*``:remove`` to remove a
937 disk by its index. The ``--disk`` *N*``:mode=``*MODE* option will change
938 the mode of the Nth disk of the instance between read-only (``ro``) and
941 The ``--net add:``*options* and ``--net`` *N*``:add,``*options* option
942 will add a new network interface to the instance. The available options
943 are the same as in the **add** command (``mac``, ``ip``, ``link``,
944 ``mode``). The ``--net remove`` will remove the last network interface
945 of the instance (``--net`` *N*``:remove`` for a specific index), while
946 the ``--net`` *N*``:``*options* option will change the parameters of the Nth
947 instance network interface.
949 The option ``-o (--os-type)`` will change the OS name for the instance
950 (without reinstallation). In case an OS variant is specified that is
951 not found, then by default the modification is refused, unless
952 ``--force-variant`` is passed. An invalid OS will also be refused,
953 unless the ``--force`` option is given.
955 The ``--online`` and ``--offline`` options are used to transition an
956 instance into and out of the ``offline`` state. An instance can be
957 turned offline only if it was previously down. The ``--online`` option
958 fails if the instance was not in the ``offline`` state, otherwise it
959 changes instance's state to ``down``. These modifications take effect
962 If ``--ignore-ipolicy`` is given any instance policy violations occuring
963 during this operation are ignored.
965 See **ganeti(7)** for a description of ``--submit`` and other common
968 Most of the changes take effect at the next restart. If the instance is
969 running, there is no effect on the instance.
974 | **reinstall** [{-o|\--os-type} *os-type*] [\--select-os] [-f *force*]
975 | [\--force-multiple]
976 | [\--instance \| \--node \| \--primary \| \--secondary \| \--all]
977 | [{-O|\--os-parameters} *OS\_PARAMETERS*] [\--submit] {*instance*...}
979 Reinstalls the operating system on the given instance(s). The
980 instance(s) must be stopped when running this command. If the ``-o
981 (--os-type)`` is specified, the operating system is changed.
983 The ``--select-os`` option switches to an interactive OS reinstall.
984 The user is prompted to select the OS template from the list of
985 available OS templates. OS parameters can be overridden using ``-O
986 (--os-parameters)`` (more documentation for this option under the
989 Since this is a potentially dangerous command, the user will be
990 required to confirm this action, unless the ``-f`` flag is passed.
991 When multiple instances are selected (either by passing multiple
992 arguments or by using the ``--node``, ``--primary``, ``--secondary``
993 or ``--all`` options), the user must pass the ``--force-multiple``
994 options to skip the interactive confirmation.
996 See **ganeti(7)** for a description of ``--submit`` and other common
1002 | **rename** [\--no-ip-check] [\--no-name-check] [\--submit]
1003 | {*instance*} {*new\_name*}
1005 Renames the given instance. The instance must be stopped when running
1006 this command. The requirements for the new name are the same as for
1007 adding an instance: the new name must be resolvable and the IP it
1008 resolves to must not be reachable (in order to prevent duplicate IPs
1009 the next time the instance is started). The IP test can be skipped if
1010 the ``--no-ip-check`` option is passed.
1012 The ``--no-name-check`` skips the check for the new instance name via
1013 the resolver (e.g. in DNS or /etc/hosts, depending on your setup) and
1014 that the resolved name matches the provided name. Since the name check
1015 is used to compute the IP address, if you pass this option you must also
1016 pass the ``--no-ip-check`` option.
1018 See **ganeti(7)** for a description of ``--submit`` and other common
1021 Starting/stopping/connecting to console
1022 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1028 | [\--force] [\--ignore-offline]
1029 | [\--force-multiple] [\--no-remember]
1030 | [\--instance \| \--node \| \--primary \| \--secondary \| \--all \|
1031 | \--tags \| \--node-tags \| \--pri-node-tags \| \--sec-node-tags]
1032 | [{-H|\--hypervisor-parameters} ``key=value...``]
1033 | [{-B|\--backend-parameters} ``key=value...``]
1034 | [\--submit] [\--paused]
1037 Starts one or more instances, depending on the following options. The
1038 four available modes are:
1041 will start the instances given as arguments (at least one argument
1042 required); this is the default selection
1045 will start the instances who have the given node as either primary
1049 will start all instances whose primary node is in the list of nodes
1050 passed as arguments (at least one node required)
1053 will start all instances whose secondary node is in the list of
1054 nodes passed as arguments (at least one node required)
1057 will start all instances in the cluster (no arguments accepted)
1060 will start all instances in the cluster with the tags given as
1064 will start all instances in the cluster on nodes with the tags
1068 will start all instances in the cluster on primary nodes with the
1069 tags given as arguments
1072 will start all instances in the cluster on secondary nodes with the
1073 tags given as arguments
1075 Note that although you can pass more than one selection option, the
1076 last one wins, so in order to guarantee the desired result, don't pass
1077 more than one such option.
1079 Use ``--force`` to start even if secondary disks are failing.
1080 ``--ignore-offline`` can be used to ignore offline primary nodes and
1081 mark the instance as started even if the primary is not available.
1083 The ``--force-multiple`` will skip the interactive confirmation in the
1084 case the more than one instance will be affected.
1086 The ``--no-remember`` option will perform the startup but not change
1087 the state of the instance in the configuration file (if it was stopped
1088 before, Ganeti will still thinks it needs to be stopped). This can be
1089 used for testing, or for a one shot-start where you don't want the
1090 watcher to restart the instance if it crashes.
1092 The ``-H (--hypervisor-parameters)`` and ``-B (--backend-parameters)``
1093 options specify temporary hypervisor and backend parameters that can
1094 be used to start an instance with modified parameters. They can be
1095 useful for quick testing without having to modify an instance back and
1098 # gnt-instance start -H kernel_args="single" instance1
1099 # gnt-instance start -B maxmem=2048 instance2
1102 The first form will start the instance instance1 in single-user mode,
1103 and the instance instance2 with 2GB of RAM (this time only, unless
1104 that is the actual instance memory size already). Note that the values
1105 override the instance parameters (and not extend them): an instance
1106 with "kernel\_args=ro" when started with -H kernel\_args=single will
1107 result in "single", not "ro single".
1109 The ``--paused`` option is only valid for Xen and kvm hypervisors. This
1110 pauses the instance at the start of bootup, awaiting ``gnt-instance
1111 console`` to unpause it, allowing the entire boot process to be
1112 monitored for debugging.
1114 See **ganeti(7)** for a description of ``--submit`` and other common
1119 # gnt-instance start instance1.example.com
1120 # gnt-instance start --node node1.example.com node2.example.com
1121 # gnt-instance start --all
1129 | [\--force-multiple] [\--ignore-offline] [\--no-remember]
1130 | [\--instance \| \--node \| \--primary \| \--secondary \| \--all \|
1131 | \--tags \| \--node-tags \| \--pri-node-tags \| \--sec-node-tags]
1135 Stops one or more instances. If the instance cannot be cleanly stopped
1136 during a hardcoded interval (currently 2 minutes), it will forcibly
1137 stop the instance (equivalent to switching off the power on a physical
1140 The ``--timeout`` is used to specify how much time to wait before
1141 forcing the shutdown (e.g. ``xm destroy`` in Xen, killing the kvm
1142 process for KVM, etc.). By default two minutes are given to each
1145 The ``--instance``, ``--node``, ``--primary``, ``--secondary``,
1146 ``--all``, ``--tags``, ``--node-tags``, ``--pri-node-tags`` and
1147 ``--sec-node-tags`` options are similar as for the **startup** command
1148 and they influence the actual instances being shutdown.
1150 ``--ignore-offline`` can be used to ignore offline primary nodes and
1151 force the instance to be marked as stopped. This option should be used
1152 with care as it can lead to an inconsistent cluster state.
1154 The ``--no-remember`` option will perform the shutdown but not change
1155 the state of the instance in the configuration file (if it was running
1156 before, Ganeti will still thinks it needs to be running). This can be
1157 useful for a cluster-wide shutdown, where some instances are marked as
1158 up and some as down, and you don't want to change the running state:
1159 you just need to disable the watcher, shutdown all instances with
1160 ``--no-remember``, and when the watcher is activated again it will
1161 restore the correct runtime state for all instances.
1163 See **ganeti(7)** for a description of ``--submit`` and other common
1168 # gnt-instance shutdown instance1.example.com
1169 # gnt-instance shutdown --all
1176 | [{-t|\--type} *REBOOT-TYPE*]
1177 | [\--ignore-secondaries]
1178 | [\--shutdown-timeout=*N*]
1179 | [\--force-multiple]
1180 | [\--instance \| \--node \| \--primary \| \--secondary \| \--all \|
1181 | \--tags \| \--node-tags \| \--pri-node-tags \| \--sec-node-tags]
1185 Reboots one or more instances. The type of reboot depends on the value
1186 of ``-t (--type)``. A soft reboot does a hypervisor reboot, a hard reboot
1187 does a instance stop, recreates the hypervisor config for the instance
1188 and starts the instance. A full reboot does the equivalent of
1189 **gnt-instance shutdown && gnt-instance startup**. The default is
1192 For the hard reboot the option ``--ignore-secondaries`` ignores errors
1193 for the secondary node while re-assembling the instance disks.
1195 The ``--instance``, ``--node``, ``--primary``, ``--secondary``,
1196 ``--all``, ``--tags``, ``--node-tags``, ``--pri-node-tags`` and
1197 ``--sec-node-tags`` options are similar as for the **startup** command
1198 and they influence the actual instances being rebooted.
1200 The ``--shutdown-timeout`` is used to specify how much time to wait
1201 before forcing the shutdown (xm destroy in xen, killing the kvm
1202 process, for kvm). By default two minutes are given to each instance
1205 The ``--force-multiple`` will skip the interactive confirmation in the
1206 case the more than one instance will be affected.
1208 See **ganeti(7)** for a description of ``--submit`` and other common
1213 # gnt-instance reboot instance1.example.com
1214 # gnt-instance reboot --type=full instance1.example.com
1220 **console** [\--show-cmd] {*instance*}
1222 Connects to the console of the given instance. If the instance is not
1223 up, an error is returned. Use the ``--show-cmd`` option to display the
1224 command instead of executing it.
1226 For HVM instances, this will attempt to connect to the serial console
1227 of the instance. To connect to the virtualized "physical" console of a
1228 HVM instance, use a VNC client with the connection info from the
1231 For Xen/kvm instances, if the instance is paused, this attempts to
1232 unpause the instance after waiting a few seconds for the connection to
1233 the console to be made.
1237 # gnt-instance console instance1.example.com
1246 **replace-disks** [\--submit] [\--early-release] [\--ignore-ipolicy] {-p}
1247 [\--disks *idx*] {*instance*}
1249 **replace-disks** [\--submit] [\--early-release] [\--ignore-ipolicy] {-s}
1250 [\--disks *idx*] {*instance*}
1252 **replace-disks** [\--submit] [\--early-release] [\--ignore-ipolicy]
1253 {{-I\|\--iallocator} *name* \| \--node *node* } {*instance*}
1255 **replace-disks** [\--submit] [\--early-release] [\--ignore-ipolicy]
1256 {\--auto} {*instance*}
1258 This command is a generalized form for replacing disks. It is
1259 currently only valid for the mirrored (DRBD) disk template.
1261 The first form (when passing the ``-p`` option) will replace the disks
1262 on the primary, while the second form (when passing the ``-s`` option
1263 will replace the disks on the secondary node. For these two cases (as
1264 the node doesn't change), it is possible to only run the replace for a
1265 subset of the disks, using the option ``--disks`` which takes a list
1266 of comma-delimited disk indices (zero-based), e.g. 0,2 to replace only
1267 the first and third disks.
1269 The third form (when passing either the ``--iallocator`` or the
1270 ``--new-secondary`` option) is designed to change secondary node of
1271 the instance. Specifying ``--iallocator`` makes the new secondary be
1272 selected automatically by the specified allocator plugin, otherwise
1273 the new secondary node will be the one chosen manually via the
1274 ``--new-secondary`` option.
1276 Note that it is not possible to select an offline or drained node as a
1279 The fourth form (when using ``--auto``) will automatically determine
1280 which disks of an instance are faulty and replace them within the same
1281 node. The ``--auto`` option works only when an instance has only
1282 faulty disks on either the primary or secondary node; it doesn't work
1283 when both sides have faulty disks.
1285 The ``--early-release`` changes the code so that the old storage on
1286 secondary node(s) is removed early (before the resync is completed)
1287 and the internal Ganeti locks for the current (and new, if any)
1288 secondary node are also released, thus allowing more parallelism in
1289 the cluster operation. This should be used only when recovering from a
1290 disk failure on the current secondary (thus the old storage is already
1291 broken) or when the storage on the primary node is known to be fine
1292 (thus we won't need the old storage for potential recovery).
1294 The ``--ignore-ipolicy`` let the command ignore instance policy
1295 violations if replace-disks changes groups and the instance would
1296 violate the new groups instance policy.
1298 See **ganeti(7)** for a description of ``--submit`` and other common
1304 **activate-disks** [\--submit] [\--ignore-size] {*instance*}
1306 Activates the block devices of the given instance. If successful, the
1307 command will show the location and name of the block devices::
1309 node1.example.com:disk/0:/dev/drbd0
1310 node1.example.com:disk/1:/dev/drbd1
1313 In this example, *node1.example.com* is the name of the node on which
1314 the devices have been activated. The *disk/0* and *disk/1* are the
1315 Ganeti-names of the instance disks; how they are visible inside the
1316 instance is hypervisor-specific. */dev/drbd0* and */dev/drbd1* are the
1317 actual block devices as visible on the node.
1319 The ``--ignore-size`` option can be used to activate disks ignoring
1320 the currently configured size in Ganeti. This can be used in cases
1321 where the configuration has gotten out of sync with the real-world
1322 (e.g. after a partially-failed grow-disk operation or due to rounding
1323 in LVM devices). This should not be used in normal cases, but only
1324 when activate-disks fails without it.
1326 Note that it is safe to run this command while the instance is already
1329 See **ganeti(7)** for a description of ``--submit`` and other common
1335 **deactivate-disks** [-f] [\--submit] {*instance*}
1337 De-activates the block devices of the given instance. Note that if you
1338 run this command for an instance with a drbd disk template, while it
1339 is running, it will not be able to shutdown the block devices on the
1340 primary node, but it will shutdown the block devices on the secondary
1341 nodes, thus breaking the replication.
1343 The ``-f``/``--force`` option will skip checks that the instance is
1344 down; in case the hypervisor is confused and we can't talk to it,
1345 normally Ganeti will refuse to deactivate the disks, but with this
1346 option passed it will skip this check and directly try to deactivate
1347 the disks. This can still fail due to the instance actually running or
1350 See **ganeti(7)** for a description of ``--submit`` and other common
1356 | **grow-disk** [\--no-wait-for-sync] [\--submit] [\--absolute]
1357 | {*instance*} {*disk*} {*amount*}
1359 Grows an instance's disk. This is only possible for instances having a
1360 plain, drbd or rbd disk template.
1362 Note that this command only change the block device size; it will not
1363 grow the actual filesystems, partitions, etc. that live on that
1364 disk. Usually, you will need to:
1366 #. use **gnt-instance grow-disk**
1368 #. reboot the instance (later, at a convenient time)
1370 #. use a filesystem resizer, such as ext2online(8) or
1371 xfs\_growfs(8) to resize the filesystem, or use fdisk(8) to change
1372 the partition table on the disk
1374 The *disk* argument is the index of the instance disk to grow. The
1375 *amount* argument is given as a number which can have a suffix (like the
1376 disk size in instance create); if the suffix is missing, the value will
1377 be interpreted as mebibytes.
1379 By default, the *amount* value represents the desired increase in the
1380 disk size (e.g. an amount of 1G will take a disk of size 3G to 4G). If
1381 the optional ``--absolute`` parameter is passed, then the *amount*
1382 argument doesn't represent the delta, but instead the desired final disk
1383 size (e.g. an amount of 8G will take a disk of size 4G to 8G).
1385 For instances with a drbd template, note that the disk grow operation
1386 might complete on one node but fail on the other; this will leave the
1387 instance with different-sized LVs on the two nodes, but this will not
1388 create problems (except for unused space).
1390 If you do not want gnt-instance to wait for the new disk region to be
1391 synced, use the ``--no-wait-for-sync`` option.
1393 See **ganeti(7)** for a description of ``--submit`` and other common
1396 Example (increase the first disk for instance1 by 16GiB)::
1398 # gnt-instance grow-disk instance1.example.com 0 16g
1400 Example for increasing the disk size to a certain size::
1402 # gnt-instance grow-disk --absolute instance1.example.com 0 32g
1404 Also note that disk shrinking is not supported; use **gnt-backup
1405 export** and then **gnt-backup import** to reduce the disk size of an
1411 | **recreate-disks** [\--submit] [-n node1:[node2]]
1412 | [\--disk=*N*[:[size=*VAL*][,mode=*ro\|rw*]]] {*instance*}
1414 Recreates all or a subset of disks of the given instance.
1416 Note that this functionality should only be used for missing disks; if
1417 any of the given disks already exists, the operation will fail. While
1418 this is suboptimal, recreate-disks should hopefully not be needed in
1419 normal operation and as such the impact of this is low.
1421 If only a subset should be recreated, any number of ``disk`` options can
1422 be specified. It expects a disk index and an optional list of disk
1423 parameters to change. Only ``size`` and ``mode`` can be changed while
1424 recreating disks. To recreate all disks while changing parameters on
1425 a subset only, a ``--disk`` option must be given for every disk of the
1428 Optionally the instance's disks can be recreated on different
1429 nodes. This can be useful if, for example, the original nodes of the
1430 instance have gone down (and are marked offline), so we can't recreate
1431 on the same nodes. To do this, pass the new node(s) via ``-n`` option,
1432 with a syntax similar to the **add** command. The number of nodes
1433 passed must equal the number of nodes that the instance currently
1434 has. Note that changing nodes is only allowed when all disks are
1435 replaced, e.g. when no ``--disk`` option is passed.
1437 See **ganeti(7)** for a description of ``--submit`` and other common
1446 | **failover** [-f] [\--ignore-consistency] [\--ignore-ipolicy]
1447 | [\--shutdown-timeout=*N*]
1448 | [{-n|\--target-node} *node* \| {-I|\--iallocator} *name*]
1452 Failover will stop the instance (if running), change its primary node,
1453 and if it was originally running it will start it again (on the new
1454 primary). This only works for instances with drbd template (in which
1455 case you can only fail to the secondary node) and for externally
1456 mirrored templates (blockdev and rbd) (which can change to any other
1459 If the instance's disk template is of type blockdev or rbd, then you
1460 can explicitly specify the target node (which can be any node) using
1461 the ``-n`` or ``--target-node`` option, or specify an iallocator plugin
1462 using the ``-I`` or ``--iallocator`` option. If you omit both, the default
1463 iallocator will be used to specify the target node.
1465 Normally the failover will check the consistency of the disks before
1466 failing over the instance. If you are trying to migrate instances off
1467 a dead node, this will fail. Use the ``--ignore-consistency`` option
1468 for this purpose. Note that this option can be dangerous as errors in
1469 shutting down the instance will be ignored, resulting in possibly
1470 having the instance running on two machines in parallel (on
1471 disconnected DRBD drives).
1473 The ``--shutdown-timeout`` is used to specify how much time to wait
1474 before forcing the shutdown (xm destroy in xen, killing the kvm
1475 process, for kvm). By default two minutes are given to each instance
1478 If ``--ignore-ipolicy`` is given any instance policy violations occuring
1479 during this operation are ignored.
1481 See **ganeti(7)** for a description of ``--submit`` and other common
1486 # gnt-instance failover instance1.example.com
1492 | **migrate** [-f] [\--allow-failover] [\--non-live]
1493 | [\--migration-mode=live\|non-live] [\--ignore-ipolicy]
1494 | [\--no-runtime-changes] [\--submit]
1495 | [{-n|\--target-node} *node* \| {-I|\--iallocator} *name*] {*instance*}
1497 | **migrate** [-f] \--cleanup [\--submit] {*instance*}
1499 Migrate will move the instance to its secondary node without shutdown.
1500 As with failover, it only works for instances having the drbd disk
1501 template or an externally mirrored disk template type such as blockdev
1504 If the instance's disk template is of type blockdev or rbd, then you can
1505 explicitly specify the target node (which can be any node) using the
1506 ``-n`` or ``--target-node`` option, or specify an iallocator plugin
1507 using the ``-I`` or ``--iallocator`` option. If you omit both, the
1508 default iallocator will be used to specify the target node.
1510 The migration command needs a perfectly healthy instance, as we rely
1511 on the dual-master capability of drbd8 and the disks of the instance
1512 are not allowed to be degraded.
1514 The ``--non-live`` and ``--migration-mode=non-live`` options will
1515 switch (for the hypervisors that support it) between a "fully live"
1516 (i.e. the interruption is as minimal as possible) migration and one in
1517 which the instance is frozen, its state saved and transported to the
1518 remote node, and then resumed there. This all depends on the
1519 hypervisor support for two different methods. In any case, it is not
1520 an error to pass this parameter (it will just be ignored if the
1521 hypervisor doesn't support it). The option ``--migration-mode=live``
1522 option will request a fully-live migration. The default, when neither
1523 option is passed, depends on the hypervisor parameters (and can be
1524 viewed with the **gnt-cluster info** command).
1526 If the ``--cleanup`` option is passed, the operation changes from
1527 migration to attempting recovery from a failed previous migration. In
1528 this mode, Ganeti checks if the instance runs on the correct node (and
1529 updates its configuration if not) and ensures the instances's disks
1530 are configured correctly. In this mode, the ``--non-live`` option is
1533 The option ``-f`` will skip the prompting for confirmation.
1535 If ``--allow-failover`` is specified it tries to fallback to failover if
1536 it already can determine that a migration won't work (e.g. if the
1537 instance is shut down). Please note that the fallback will not happen
1538 during execution. If a migration fails during execution it still fails.
1540 If ``--ignore-ipolicy`` is given any instance policy violations occuring
1541 during this operation are ignored.
1543 The ``--no-runtime-changes`` option forbids migrate to alter an
1544 instance's runtime before migrating it (eg. ballooning an instance
1545 down because the target node doesn't have enough available memory).
1547 See **ganeti(7)** for a description of ``--submit`` and other common
1550 Example (and expected output)::
1552 # gnt-instance migrate instance1
1553 Instance instance1 will be migrated. Note that migration
1554 might impact the instance if anything goes wrong (e.g. due to bugs in
1555 the hypervisor). Continue?
1557 Migrating instance instance1.example.com
1558 * checking disk consistency between source and target
1559 * switching node node2.example.com to secondary mode
1560 * changing into standalone mode
1561 * changing disks into dual-master mode
1562 * wait until resync is done
1563 * preparing node2.example.com to accept the instance
1564 * migrating instance to node2.example.com
1565 * switching node node1.example.com to secondary mode
1566 * wait until resync is done
1567 * changing into standalone mode
1568 * changing disks into single-master mode
1569 * wait until resync is done
1577 | **move** [-f] [\--ignore-consistency]
1578 | [-n *node*] [\--shutdown-timeout=*N*] [\--submit] [\--ignore-ipolicy]
1581 Move will move the instance to an arbitrary node in the cluster. This
1582 works only for instances having a plain or file disk template.
1584 Note that since this operation is done via data copy, it will take a
1585 long time for big disks (similar to replace-disks for a drbd
1588 The ``--shutdown-timeout`` is used to specify how much time to wait
1589 before forcing the shutdown (e.g. ``xm destroy`` in XEN, killing the
1590 kvm process for KVM, etc.). By default two minutes are given to each
1593 The ``--ignore-consistency`` option will make Ganeti ignore any errors
1594 in trying to shutdown the instance on its node; useful if the
1595 hypervisor is broken and you want to recuperate the data.
1597 If ``--ignore-ipolicy`` is given any instance policy violations occuring
1598 during this operation are ignored.
1600 See **ganeti(7)** for a description of ``--submit`` and other common
1605 # gnt-instance move -n node3.example.com instance1.example.com
1611 | **change-group** [\--submit]
1612 | [\--iallocator *NAME*] [\--to *GROUP*...] {*instance*}
1614 This command moves an instance to another node group. The move is
1615 calculated by an iallocator, either given on the command line or as a
1618 If no specific destination groups are specified using ``--to``, all
1619 groups except the one containing the instance are considered.
1621 See **ganeti(7)** for a description of ``--submit`` and other common
1626 # gnt-instance change-group -I hail --to rack2 inst1.example.com
1635 **add-tags** [\--from *file*] {*instancename*} {*tag*...}
1637 Add tags to the given instance. If any of the tags contains invalid
1638 characters, the entire operation will abort.
1640 If the ``--from`` option is given, the list of tags will be extended
1641 with the contents of that file (each line becomes a tag). In this
1642 case, there is not need to pass tags on the command line (if you do,
1643 both sources will be used). A file name of ``-`` will be interpreted
1649 **list-tags** {*instancename*}
1651 List the tags of the given instance.
1656 **remove-tags** [\--from *file*] {*instancename*} {*tag*...}
1658 Remove tags from the given instance. If any of the tags are not
1659 existing on the node, the entire operation will abort.
1661 If the ``--from`` option is given, the list of tags to be removed will
1662 be extended with the contents of that file (each line becomes a tag).
1663 In this case, there is not need to pass tags on the command line (if
1664 you do, tags from both sources will be removed). A file name of ``-``
1665 will be interpreted as stdin.
1667 .. vim: set textwidth=72 :