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 LXC hypervisor.
532 The processes belonging to the given instance are only scheduled
533 on the specified CPUs.
535 The parameter format is a comma-separated list of CPU IDs or CPU
536 ID ranges. The ranges are defined by a lower and higher boundary,
537 separated by a dash. The boundaries are inclusive.
540 Valid for the KVM hypervisor.
542 This option specifies the usb mouse type to be used. It can be
543 "mouse" or "tablet". When using VNC it's recommended to set it to
547 Valid for the KVM hypervisor.
549 This option specifies the keyboard mapping to be used. It is only
550 needed when using the VNC console. For example: "fr" or "en-gb".
553 Valid for Xen PVM, Xen HVM and KVM hypervisors.
555 Normally if an instance reboots, the hypervisor will restart it. If
556 this option is set to ``exit``, the hypervisor will treat a reboot
557 as a shutdown instead.
559 It is set to ``reboot`` by default.
562 The ``-O (--os-parameters)`` option allows customisation of the OS
563 parameters. The actual parameter names and values depends on the OS
564 being used, but the syntax is the same key=value. For example, setting
565 a hypothetical ``dhcp`` parameter to yes can be achieved by::
567 gnt-instance add -O dhcp=yes ...
569 The ``-I (--iallocator)`` option specifies the instance allocator
570 plugin to use. If you pass in this option the allocator will select
571 nodes for this instance automatically, so you don't need to pass them
572 with the ``-n`` option. For more information please refer to the
573 instance allocator documentation.
575 The ``-t (--disk-template)`` options specifies the disk layout type
576 for the instance. The available choices are:
579 This creates an instance with no disks. Its useful for testing only
580 (or other special cases).
583 Disk devices will be regular files.
586 Disk devices will be logical volumes.
589 Disk devices will be drbd (version 8.x) on top of lvm volumes.
592 Disk devices will be rbd volumes residing inside a RADOS cluster.
595 The optional second value of the ``-n (--node)`` is used for the drbd
596 template type and specifies the remote node.
598 If you do not want gnt-instance to wait for the disk mirror to be
599 synced, use the ``--no-wait-for-sync`` option.
601 The ``--file-storage-dir`` specifies the relative path under the
602 cluster-wide file storage directory to store file-based disks. It is
603 useful for having different subdirectories for different
604 instances. The full path of the directory where the disk files are
605 stored will consist of cluster-wide file storage directory + optional
606 subdirectory + instance name. Example:
607 ``@RPL_FILE_STORAGE_DIR@``*/mysubdir/instance1.example.com*. This
608 option is only relevant for instances using the file storage backend.
610 The ``--file-driver`` specifies the driver to use for file-based
611 disks. Note that currently these drivers work with the xen hypervisor
612 only. This option is only relevant for instances using the file
613 storage backend. The available choices are:
616 Kernel loopback driver. This driver uses loopback devices to
617 access the filesystem within the file. However, running I/O
618 intensive applications in your instance using the loop driver
619 might result in slowdowns. Furthermore, if you use the loopback
620 driver consider increasing the maximum amount of loopback devices
621 (on most systems it's 8) using the max\_loop param.
624 The blktap driver (for Xen hypervisors). In order to be able to
625 use the blktap driver you should check if the 'blktapctrl' user
626 space disk agent is running (usually automatically started via
627 xend). This user-level disk I/O interface has the advantage of
628 better performance. Especially if you use a network file system
629 (e.g. NFS) to store your instances this is the recommended choice.
632 The ``--submit`` option is used to send the job to the master daemon
633 but not wait for its completion. The job ID will be shown so that it
634 can be examined via **gnt-job info**.
636 If ``--ignore-ipolicy`` is given any instance policy violations occuring
637 during this operation are ignored.
641 # gnt-instance add -t file --disk 0:size=30g -B maxmem=512 -o debian-etch \
642 -n node1.example.com --file-storage-dir=mysubdir instance1.example.com
643 # gnt-instance add -t plain --disk 0:size=30g -B maxmem=1024,minmem=512 \
644 -o debian-etch -n node1.example.com instance1.example.com
645 # gnt-instance add -t plain --disk 0:size=30g --disk 1:size=100g,vg=san \
646 -B maxmem=512 -o debian-etch -n node1.example.com instance1.example.com
647 # gnt-instance add -t drbd --disk 0:size=30g -B maxmem=512 -o debian-etch \
648 -n node1.example.com:node2.example.com instance2.example.com
654 **batch-create** {instances\_file.json}
656 This command (similar to the Ganeti 1.2 **batcher** tool) submits
657 multiple instance creation jobs based on a definition file. The
658 instance configurations do not encompass all the possible options for
659 the **add** command, but only a subset.
661 The instance file should be a valid-formed JSON file, containing a
662 dictionary with instance name and instance parameters. The accepted
666 The size of the disks of the instance.
669 The disk template to use for the instance, the same as in the
673 A dictionary of backend parameters.
676 A dictionary with a single key (the hypervisor name), and as value
677 the hypervisor options. If not passed, the default hypervisor and
678 hypervisor options will be inherited.
681 Specifications for the one NIC that will be created for the
682 instance. 'bridge' is also accepted as a backwards compatibile
686 List of nics that will be created for the instance. Each entry
687 should be a dict, with mac, ip, mode and link as possible keys.
688 Please don't provide the "mac, ip, mode, link" parent keys if you
689 use this method for specifying nics.
691 primary\_node, secondary\_node
692 The primary and optionally the secondary node to use for the
693 instance (in case an iallocator script is not used).
696 Instead of specifying the nodes, an iallocator script can be used
697 to automatically compute them.
700 whether to start the instance
703 Skip the check for already-in-use instance; see the description in
704 the **add** command for details.
707 Skip the name check for instances; see the description in the
708 **add** command for details.
710 file\_storage\_dir, file\_driver
711 Configuration for the file disk type, see the **add** command for
715 A simple definition for one instance can be (with most of the
716 parameters taken from the cluster defaults)::
722 "disk_size": ["25G"],
728 "disk_size": ["25G"],
729 "iallocator": "dumb",
730 "hypervisor": "xen-hvm",
731 "hvparams": {"acpi": true},
732 "backend": {"maxmem": 512, "minmem": 256}
736 The command will display the job id for each submitted instance, as
739 # gnt-instance batch-create instances.json
746 **remove** [\--ignore-failures] [\--shutdown-timeout=*N*] [\--submit]
747 [\--force] {*instance*}
749 Remove an instance. This will remove all data from the instance and
750 there is *no way back*. If you are not sure if you use an instance
751 again, use **shutdown** first and leave it in the shutdown state for a
754 The ``--ignore-failures`` option will cause the removal to proceed
755 even in the presence of errors during the removal of the instance
756 (e.g. during the shutdown or the disk removal). If this option is not
757 given, the command will stop at the first error.
759 The ``--shutdown-timeout`` is used to specify how much time to wait
760 before forcing the shutdown (e.g. ``xm destroy`` in Xen, killing the
761 kvm process for KVM, etc.). By default two minutes are given to each
764 The ``--submit`` option is used to send the job to the master daemon
765 but not wait for its completion. The job ID will be shown so that it
766 can be examined via **gnt-job info**.
768 The ``--force`` option is used to skip the interactive confirmation.
772 # gnt-instance remove instance1.example.com
779 | [\--no-headers] [\--separator=*SEPARATOR*] [\--units=*UNITS*] [-v]
780 | [{-o|\--output} *[+]FIELD,...*] [\--filter] [instance...]
782 Shows the currently configured instances with memory usage, disk
783 usage, the node they are running on, and their run status.
785 The ``--no-headers`` option will skip the initial header line. The
786 ``--separator`` option takes an argument which denotes what will be
787 used between the output fields. Both these options are to help
790 The units used to display the numeric values in the output varies,
791 depending on the options given. By default, the values will be
792 formatted in the most appropriate unit. If the ``--separator`` option
793 is given, then the values are shown in mebibytes to allow parsing by
794 scripts. In both cases, the ``--units`` option can be used to enforce
797 The ``-v`` option activates verbose mode, which changes the display of
798 special field states (see **ganeti(7)**).
800 The ``-o (--output)`` option takes a comma-separated list of output
801 fields. The available fields and their meaning are:
803 @QUERY_FIELDS_INSTANCE@
805 If the value of the option starts with the character ``+``, the new
806 field(s) will be added to the default list. This allows one to quickly
807 see the default list plus a few other fields, instead of retyping the
808 entire list of fields.
810 There is a subtle grouping about the available output fields: all
811 fields except for ``oper_state``, ``oper_ram``, ``oper_vcpus`` and
812 ``status`` are configuration value and not run-time values. So if you
813 don't select any of the these fields, the query will be satisfied
814 instantly from the cluster configuration, without having to ask the
815 remote nodes for the data. This can be helpful for big clusters when
816 you only want some data and it makes sense to specify a reduced set of
819 If exactly one argument is given and it appears to be a query filter
820 (see **ganeti(7)**), the query result is filtered accordingly. For
821 ambiguous cases (e.g. a single field name as a filter) the ``--filter``
822 (``-F``) option forces the argument to be treated as a filter (e.g.
823 ``gnt-instance list -F admin_state``).
825 The default output field list is: ``name``, ``os``, ``pnode``,
826 ``admin_state``, ``oper_state``, ``oper_ram``.
832 **list-fields** [field...]
834 Lists available fields for instances.
840 **info** [-s \| \--static] [\--roman] {\--all \| *instance*}
842 Show detailed information about the given instance(s). This is
843 different from **list** as it shows detailed data about the instance's
844 disks (especially useful for the drbd disk template).
846 If the option ``-s`` is used, only information available in the
847 configuration file is returned, without querying nodes, making the
850 Use the ``--all`` to get info about all instances, rather than
851 explicitly passing the ones you're interested in.
853 The ``--roman`` option can be used to cause envy among people who like
854 ancient cultures, but are stuck with non-latin-friendly cluster
855 virtualization technologies.
861 | [{-H|\--hypervisor-parameters} *HYPERVISOR\_PARAMETERS*]
862 | [{-B|\--backend-parameters} *BACKEND\_PARAMETERS*]
863 | [{-m|\--runtime-memory} *SIZE*]
864 | [\--net add*[:options]* \| \--net remove \| \--net *N:options*]
865 | [\--disk add:size=*SIZE*[,vg=*VG*][,metavg=*VG*] \| \--disk remove \|
866 | \--disk *N*:mode=*MODE*]
867 | [{-t|\--disk-template} plain | {-t|\--disk-template} drbd -n *new_secondary*] [\--no-wait-for-sync]
868 | [\--os-type=*OS* [\--force-variant]]
869 | [{-O|\--os-parameters} *param*=*value*... ]
870 | [\--offline \| \--online]
872 | [\--ignore-ipolicy]
875 Modifies the memory size, number of vcpus, ip address, MAC address
876 and/or nic parameters for an instance. It can also add and remove
877 disks and NICs to/from the instance. Note that you need to give at
878 least one of the arguments, otherwise the command complains.
880 The ``-H (--hypervisor-parameters)``, ``-B (--backend-parameters)``
881 and ``-O (--os-parameters)`` options specifies hypervisor, backend and
882 OS parameter options in the form of name=value[,...]. For details
883 which options can be specified, see the **add** command.
885 The ``-t (--disk-template)`` option will change the disk template of
886 the instance. Currently only conversions between the plain and drbd
887 disk templates are supported, and the instance must be stopped before
888 attempting the conversion. When changing from the plain to the drbd
889 disk template, a new secondary node must be specified via the ``-n``
890 option. The option ``--no-wait-for-sync`` can be used when converting
891 to the ``drbd`` template in order to make the instance available for
892 startup before DRBD has finished resyncing.
894 The ``-m (--runtime-memory)`` option will change an instance's runtime
895 memory to the given size (in MB if a different suffix is not specified),
896 by ballooning it up or down to the new value.
898 The ``--disk add:size=``*SIZE* option adds a disk to the instance. The
899 optional ``vg=``*VG* option specifies an LVM volume group other than
900 the default volume group to create the disk on. For DRBD disks, the
901 ``metavg=``*VG* option specifies the volume group for the metadata
902 device. ``--disk`` *N*``:add,size=``**SIZE** can be used to add a
903 disk at a specific index. The ``--disk remove`` option will remove the
904 last disk of the instance. Use ``--disk ``*N*``:remove`` to remove a
905 disk by its index. The ``--disk`` *N*``:mode=``*MODE* option will change
906 the mode of the Nth disk of the instance between read-only (``ro``) and
909 The ``--net add:``*options* and ``--net`` *N*``:add,``*options* option
910 will add a new network interface to the instance. The available options
911 are the same as in the **add** command (``mac``, ``ip``, ``link``,
912 ``mode``). The ``--net remove`` will remove the last network interface
913 of the instance (``--net`` *N*``:remove`` for a specific index), while
914 the ``--net`` *N*``:``*options* option will change the parameters of the Nth
915 instance network interface.
917 The option ``-o (--os-type)`` will change the OS name for the instance
918 (without reinstallation). In case an OS variant is specified that is
919 not found, then by default the modification is refused, unless
920 ``--force-variant`` is passed. An invalid OS will also be refused,
921 unless the ``--force`` option is given.
923 The ``--online`` and ``--offline`` options are used to transition an
924 instance into and out of the ``offline`` state. An instance can be
925 turned offline only if it was previously down. The ``--online`` option
926 fails if the instance was not in the ``offline`` state, otherwise it
927 changes instance's state to ``down``. These modifications take effect
930 The ``--submit`` option is used to send the job to the master daemon
931 but not wait for its completion. The job ID will be shown so that it
932 can be examined via **gnt-job info**.
934 If ``--ignore-ipolicy`` is given any instance policy violations occuring
935 during this operation are ignored.
937 Most of the changes take effect at the next restart. If the instance is
938 running, there is no effect on the instance.
943 | **reinstall** [{-o|\--os-type} *os-type*] [\--select-os] [-f *force*]
944 | [\--force-multiple]
945 | [\--instance \| \--node \| \--primary \| \--secondary \| \--all]
946 | [{-O|\--os-parameters} *OS\_PARAMETERS*] [\--submit] {*instance*...}
948 Reinstalls the operating system on the given instance(s). The
949 instance(s) must be stopped when running this command. If the ``-o
950 (--os-type)`` is specified, the operating system is changed.
952 The ``--select-os`` option switches to an interactive OS reinstall.
953 The user is prompted to select the OS template from the list of
954 available OS templates. OS parameters can be overridden using ``-O
955 (--os-parameters)`` (more documentation for this option under the
958 Since this is a potentially dangerous command, the user will be
959 required to confirm this action, unless the ``-f`` flag is passed.
960 When multiple instances are selected (either by passing multiple
961 arguments or by using the ``--node``, ``--primary``, ``--secondary``
962 or ``--all`` options), the user must pass the ``--force-multiple``
963 options to skip the interactive confirmation.
965 The ``--submit`` option is used to send the job to the master daemon
966 but not wait for its completion. The job ID will be shown so that it
967 can be examined via **gnt-job info**.
972 | **rename** [\--no-ip-check] [\--no-name-check] [\--submit]
973 | {*instance*} {*new\_name*}
975 Renames the given instance. The instance must be stopped when running
976 this command. The requirements for the new name are the same as for
977 adding an instance: the new name must be resolvable and the IP it
978 resolves to must not be reachable (in order to prevent duplicate IPs
979 the next time the instance is started). The IP test can be skipped if
980 the ``--no-ip-check`` option is passed.
982 The ``--no-name-check`` skips the check for the new instance name via
983 the resolver (e.g. in DNS or /etc/hosts, depending on your setup) and
984 that the resolved name matches the provided name. Since the name check
985 is used to compute the IP address, if you pass this option you must also
986 pass the ``--no-ip-check`` option.
988 The ``--submit`` option is used to send the job to the master daemon
989 but not wait for its completion. The job ID will be shown so that it
990 can be examined via **gnt-job info**.
992 Starting/stopping/connecting to console
993 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
999 | [\--force] [\--ignore-offline]
1000 | [\--force-multiple] [\--no-remember]
1001 | [\--instance \| \--node \| \--primary \| \--secondary \| \--all \|
1002 | \--tags \| \--node-tags \| \--pri-node-tags \| \--sec-node-tags]
1003 | [{-H|\--hypervisor-parameters} ``key=value...``]
1004 | [{-B|\--backend-parameters} ``key=value...``]
1005 | [\--submit] [\--paused]
1008 Starts one or more instances, depending on the following options. The
1009 four available modes are:
1012 will start the instances given as arguments (at least one argument
1013 required); this is the default selection
1016 will start the instances who have the given node as either primary
1020 will start all instances whose primary node is in the list of nodes
1021 passed as arguments (at least one node required)
1024 will start all instances whose secondary node is in the list of
1025 nodes passed as arguments (at least one node required)
1028 will start all instances in the cluster (no arguments accepted)
1031 will start all instances in the cluster with the tags given as
1035 will start all instances in the cluster on nodes with the tags
1039 will start all instances in the cluster on primary nodes with the
1040 tags given as arguments
1043 will start all instances in the cluster on secondary nodes with the
1044 tags given as arguments
1046 Note that although you can pass more than one selection option, the
1047 last one wins, so in order to guarantee the desired result, don't pass
1048 more than one such option.
1050 Use ``--force`` to start even if secondary disks are failing.
1051 ``--ignore-offline`` can be used to ignore offline primary nodes and
1052 mark the instance as started even if the primary is not available.
1054 The ``--force-multiple`` will skip the interactive confirmation in the
1055 case the more than one instance will be affected.
1057 The ``--no-remember`` option will perform the startup but not change
1058 the state of the instance in the configuration file (if it was stopped
1059 before, Ganeti will still thinks it needs to be stopped). This can be
1060 used for testing, or for a one shot-start where you don't want the
1061 watcher to restart the instance if it crashes.
1063 The ``-H (--hypervisor-parameters)`` and ``-B (--backend-parameters)``
1064 options specify temporary hypervisor and backend parameters that can
1065 be used to start an instance with modified parameters. They can be
1066 useful for quick testing without having to modify an instance back and
1069 # gnt-instance start -H kernel_args="single" instance1
1070 # gnt-instance start -B maxmem=2048 instance2
1073 The first form will start the instance instance1 in single-user mode,
1074 and the instance instance2 with 2GB of RAM (this time only, unless
1075 that is the actual instance memory size already). Note that the values
1076 override the instance parameters (and not extend them): an instance
1077 with "kernel\_args=ro" when started with -H kernel\_args=single will
1078 result in "single", not "ro single". The ``--submit`` option is used
1079 to send the job to the master daemon but not wait for its
1080 completion. The job ID will be shown so that it can be examined via
1083 The ``--paused`` option is only valid for Xen and kvm hypervisors. This
1084 pauses the instance at the start of bootup, awaiting ``gnt-instance
1085 console`` to unpause it, allowing the entire boot process to be
1086 monitored for debugging.
1090 # gnt-instance start instance1.example.com
1091 # gnt-instance start --node node1.example.com node2.example.com
1092 # gnt-instance start --all
1100 | [\--force-multiple] [\--ignore-offline] [\--no-remember]
1101 | [\--instance \| \--node \| \--primary \| \--secondary \| \--all \|
1102 | \--tags \| \--node-tags \| \--pri-node-tags \| \--sec-node-tags]
1106 Stops one or more instances. If the instance cannot be cleanly stopped
1107 during a hardcoded interval (currently 2 minutes), it will forcibly
1108 stop the instance (equivalent to switching off the power on a physical
1111 The ``--timeout`` is used to specify how much time to wait before
1112 forcing the shutdown (e.g. ``xm destroy`` in Xen, killing the kvm
1113 process for KVM, etc.). By default two minutes are given to each
1116 The ``--instance``, ``--node``, ``--primary``, ``--secondary``,
1117 ``--all``, ``--tags``, ``--node-tags``, ``--pri-node-tags`` and
1118 ``--sec-node-tags`` options are similar as for the **startup** command
1119 and they influence the actual instances being shutdown.
1121 The ``--submit`` option is used to send the job to the master daemon
1122 but not wait for its completion. The job ID will be shown so that it
1123 can be examined via **gnt-job info**.
1125 ``--ignore-offline`` can be used to ignore offline primary nodes and
1126 force the instance to be marked as stopped. This option should be used
1127 with care as it can lead to an inconsistent cluster state.
1129 The ``--no-remember`` option will perform the shutdown but not change
1130 the state of the instance in the configuration file (if it was running
1131 before, Ganeti will still thinks it needs to be running). This can be
1132 useful for a cluster-wide shutdown, where some instances are marked as
1133 up and some as down, and you don't want to change the running state:
1134 you just need to disable the watcher, shutdown all instances with
1135 ``--no-remember``, and when the watcher is activated again it will
1136 restore the correct runtime state for all instances.
1140 # gnt-instance shutdown instance1.example.com
1141 # gnt-instance shutdown --all
1148 | [{-t|\--type} *REBOOT-TYPE*]
1149 | [\--ignore-secondaries]
1150 | [\--shutdown-timeout=*N*]
1151 | [\--force-multiple]
1152 | [\--instance \| \--node \| \--primary \| \--secondary \| \--all \|
1153 | \--tags \| \--node-tags \| \--pri-node-tags \| \--sec-node-tags]
1157 Reboots one or more instances. The type of reboot depends on the value
1158 of ``-t (--type)``. A soft reboot does a hypervisor reboot, a hard reboot
1159 does a instance stop, recreates the hypervisor config for the instance
1160 and starts the instance. A full reboot does the equivalent of
1161 **gnt-instance shutdown && gnt-instance startup**. The default is
1164 For the hard reboot the option ``--ignore-secondaries`` ignores errors
1165 for the secondary node while re-assembling the instance disks.
1167 The ``--instance``, ``--node``, ``--primary``, ``--secondary``,
1168 ``--all``, ``--tags``, ``--node-tags``, ``--pri-node-tags`` and
1169 ``--sec-node-tags`` options are similar as for the **startup** command
1170 and they influence the actual instances being rebooted.
1172 The ``--shutdown-timeout`` is used to specify how much time to wait
1173 before forcing the shutdown (xm destroy in xen, killing the kvm
1174 process, for kvm). By default two minutes are given to each instance
1177 The ``--force-multiple`` will skip the interactive confirmation in the
1178 case the more than one instance will be affected.
1182 # gnt-instance reboot instance1.example.com
1183 # gnt-instance reboot --type=full instance1.example.com
1189 **console** [\--show-cmd] {*instance*}
1191 Connects to the console of the given instance. If the instance is not
1192 up, an error is returned. Use the ``--show-cmd`` option to display the
1193 command instead of executing it.
1195 For HVM instances, this will attempt to connect to the serial console
1196 of the instance. To connect to the virtualized "physical" console of a
1197 HVM instance, use a VNC client with the connection info from the
1200 For Xen/kvm instances, if the instance is paused, this attempts to
1201 unpause the instance after waiting a few seconds for the connection to
1202 the console to be made.
1206 # gnt-instance console instance1.example.com
1215 **replace-disks** [\--submit] [\--early-release] [\--ignore-ipolicy] {-p}
1216 [\--disks *idx*] {*instance*}
1218 **replace-disks** [\--submit] [\--early-release] [\--ignore-ipolicy] {-s}
1219 [\--disks *idx*] {*instance*}
1221 **replace-disks** [\--submit] [\--early-release] [\--ignore-ipolicy]
1222 {\--iallocator *name* \| \--node *node* } {*instance*}
1224 **replace-disks** [\--submit] [\--early-release] [\--ignore-ipolicy]
1225 {\--auto} {*instance*}
1227 This command is a generalized form for replacing disks. It is
1228 currently only valid for the mirrored (DRBD) disk template.
1230 The first form (when passing the ``-p`` option) will replace the disks
1231 on the primary, while the second form (when passing the ``-s`` option
1232 will replace the disks on the secondary node. For these two cases (as
1233 the node doesn't change), it is possible to only run the replace for a
1234 subset of the disks, using the option ``--disks`` which takes a list
1235 of comma-delimited disk indices (zero-based), e.g. 0,2 to replace only
1236 the first and third disks.
1238 The third form (when passing either the ``--iallocator`` or the
1239 ``--new-secondary`` option) is designed to change secondary node of
1240 the instance. Specifying ``--iallocator`` makes the new secondary be
1241 selected automatically by the specified allocator plugin, otherwise
1242 the new secondary node will be the one chosen manually via the
1243 ``--new-secondary`` option.
1245 The fourth form (when using ``--auto``) will automatically determine
1246 which disks of an instance are faulty and replace them within the same
1247 node. The ``--auto`` option works only when an instance has only
1248 faulty disks on either the primary or secondary node; it doesn't work
1249 when both sides have faulty disks.
1251 The ``--submit`` option is used to send the job to the master daemon
1252 but not wait for its completion. The job ID will be shown so that it
1253 can be examined via **gnt-job info**.
1255 The ``--early-release`` changes the code so that the old storage on
1256 secondary node(s) is removed early (before the resync is completed)
1257 and the internal Ganeti locks for the current (and new, if any)
1258 secondary node are also released, thus allowing more parallelism in
1259 the cluster operation. This should be used only when recovering from a
1260 disk failure on the current secondary (thus the old storage is already
1261 broken) or when the storage on the primary node is known to be fine
1262 (thus we won't need the old storage for potential recovery).
1264 The ``--ignore-ipolicy`` let the command ignore instance policy
1265 violations if replace-disks changes groups and the instance would
1266 violate the new groups instance policy.
1268 Note that it is not possible to select an offline or drained node as a
1274 **activate-disks** [\--submit] [\--ignore-size] {*instance*}
1276 Activates the block devices of the given instance. If successful, the
1277 command will show the location and name of the block devices::
1279 node1.example.com:disk/0:/dev/drbd0
1280 node1.example.com:disk/1:/dev/drbd1
1283 In this example, *node1.example.com* is the name of the node on which
1284 the devices have been activated. The *disk/0* and *disk/1* are the
1285 Ganeti-names of the instance disks; how they are visible inside the
1286 instance is hypervisor-specific. */dev/drbd0* and */dev/drbd1* are the
1287 actual block devices as visible on the node. The ``--submit`` option
1288 is used to send the job to the master daemon but not wait for its
1289 completion. The job ID will be shown so that it can be examined via
1292 The ``--ignore-size`` option can be used to activate disks ignoring
1293 the currently configured size in Ganeti. This can be used in cases
1294 where the configuration has gotten out of sync with the real-world
1295 (e.g. after a partially-failed grow-disk operation or due to rounding
1296 in LVM devices). This should not be used in normal cases, but only
1297 when activate-disks fails without it.
1299 Note that it is safe to run this command while the instance is already
1305 **deactivate-disks** [-f] [\--submit] {*instance*}
1307 De-activates the block devices of the given instance. Note that if you
1308 run this command for an instance with a drbd disk template, while it
1309 is running, it will not be able to shutdown the block devices on the
1310 primary node, but it will shutdown the block devices on the secondary
1311 nodes, thus breaking the replication.
1313 The ``-f``/``--force`` option will skip checks that the instance is
1314 down; in case the hypervisor is confused and we can't talk to it,
1315 normally Ganeti will refuse to deactivate the disks, but with this
1316 option passed it will skip this check and directly try to deactivate
1317 the disks. This can still fail due to the instance actually running or
1320 The ``--submit`` option is used to send the job to the master daemon
1321 but not wait for its completion. The job ID will be shown so that it
1322 can be examined via **gnt-job info**.
1327 **grow-disk** [\--no-wait-for-sync] [\--submit] {*instance*} {*disk*}
1330 Grows an instance's disk. This is only possible for instances having a
1331 plain, drbd or rbd disk template.
1333 Note that this command only change the block device size; it will not
1334 grow the actual filesystems, partitions, etc. that live on that
1335 disk. Usually, you will need to:
1337 #. use **gnt-instance grow-disk**
1339 #. reboot the instance (later, at a convenient time)
1341 #. use a filesystem resizer, such as ext2online(8) or
1342 xfs\_growfs(8) to resize the filesystem, or use fdisk(8) to change
1343 the partition table on the disk
1345 The *disk* argument is the index of the instance disk to grow. The
1346 *amount* argument is given either as a number (and it represents the
1347 amount to increase the disk with in mebibytes) or can be given similar
1348 to the arguments in the create instance operation, with a suffix
1351 For instances with a drbd template, note that the disk grow operation
1352 might complete on one node but fail on the other; this will leave the
1353 instance with different-sized LVs on the two nodes, but this will not
1354 create problems (except for unused space).
1356 If you do not want gnt-instance to wait for the new disk region to be
1357 synced, use the ``--no-wait-for-sync`` option.
1359 The ``--submit`` option is used to send the job to the master daemon
1360 but not wait for its completion. The job ID will be shown so that it
1361 can be examined via **gnt-job info**.
1363 Example (increase the first disk for instance1 by 16GiB)::
1365 # gnt-instance grow-disk instance1.example.com 0 16g
1368 Also note that disk shrinking is not supported; use **gnt-backup
1369 export** and then **gnt-backup import** to reduce the disk size of an
1375 | **recreate-disks** [\--submit] [-n node1:[node2]]
1376 | [\--disk=*N*[:[size=*VAL*][,mode=*ro\|rw*]]] {*instance*}
1378 Recreates all or a subset of disks of the given instance.
1380 Note that this functionality should only be used for missing disks; if
1381 any of the given disks already exists, the operation will fail. While
1382 this is suboptimal, recreate-disks should hopefully not be needed in
1383 normal operation and as such the impact of this is low.
1385 If only a subset should be recreated, any number of ``disk`` options can
1386 be specified. It expects a disk index and an optional list of disk
1387 parameters to change. Only ``size`` and ``mode`` can be changed while
1388 recreating disks. To recreate all disks while changing parameters on
1389 a subset only, a ``--disk`` option must be given for every disk of the
1392 Optionally the instance's disks can be recreated on different
1393 nodes. This can be useful if, for example, the original nodes of the
1394 instance have gone down (and are marked offline), so we can't recreate
1395 on the same nodes. To do this, pass the new node(s) via ``-n`` option,
1396 with a syntax similar to the **add** command. The number of nodes
1397 passed must equal the number of nodes that the instance currently
1398 has. Note that changing nodes is only allowed when all disks are
1399 replaced, e.g. when no ``--disk`` option is passed.
1401 The ``--submit`` option is used to send the job to the master daemon
1402 but not wait for its completion. The job ID will be shown so that it
1403 can be examined via **gnt-job info**.
1411 | **failover** [-f] [\--ignore-consistency] [\--ignore-ipolicy]
1412 | [\--shutdown-timeout=*N*]
1413 | [{-n|\--target-node} *node* \| {-I|\--iallocator} *name*]
1417 Failover will stop the instance (if running), change its primary node,
1418 and if it was originally running it will start it again (on the new
1419 primary). This only works for instances with drbd template (in which
1420 case you can only fail to the secondary node) and for externally
1421 mirrored templates (blockdev and rbd) (which can change to any other
1424 If the instance's disk template is of type blockdev or rbd, then you
1425 can explicitly specify the target node (which can be any node) using
1426 the ``-n`` or ``--target-node`` option, or specify an iallocator plugin
1427 using the ``-I`` or ``--iallocator`` option. If you omit both, the default
1428 iallocator will be used to specify the target node.
1430 Normally the failover will check the consistency of the disks before
1431 failing over the instance. If you are trying to migrate instances off
1432 a dead node, this will fail. Use the ``--ignore-consistency`` option
1433 for this purpose. Note that this option can be dangerous as errors in
1434 shutting down the instance will be ignored, resulting in possibly
1435 having the instance running on two machines in parallel (on
1436 disconnected DRBD drives).
1438 The ``--shutdown-timeout`` is used to specify how much time to wait
1439 before forcing the shutdown (xm destroy in xen, killing the kvm
1440 process, for kvm). By default two minutes are given to each instance
1443 The ``--submit`` option is used to send the job to the master daemon
1444 but not wait for its completion. The job ID will be shown so that it
1445 can be examined via **gnt-job info**.
1447 If ``--ignore-ipolicy`` is given any instance policy violations occuring
1448 during this operation are ignored.
1452 # gnt-instance failover instance1.example.com
1458 **migrate** [-f] {\--cleanup} {*instance*}
1460 **migrate** [-f] [\--allow-failover] [\--non-live]
1461 [\--migration-mode=live\|non-live] [\--ignore-ipolicy]
1462 [\--no-runtime-changes]
1463 [{-n|\--target-node} *node* \| {-I|\--iallocator} *name*] {*instance*}
1465 Migrate will move the instance to its secondary node without shutdown.
1466 As with failover, it only works for instances having the drbd disk
1467 template or an externally mirrored disk template type such as blockdev
1470 If the instance's disk template is of type blockdev or rbd, then you can
1471 explicitly specify the target node (which can be any node) using the
1472 ``-n`` or ``--target-node`` option, or specify an iallocator plugin
1473 using the ``-I`` or ``--iallocator`` option. If you omit both, the
1474 default iallocator will be used to specify the target node.
1476 The migration command needs a perfectly healthy instance, as we rely
1477 on the dual-master capability of drbd8 and the disks of the instance
1478 are not allowed to be degraded.
1480 The ``--non-live`` and ``--migration-mode=non-live`` options will
1481 switch (for the hypervisors that support it) between a "fully live"
1482 (i.e. the interruption is as minimal as possible) migration and one in
1483 which the instance is frozen, its state saved and transported to the
1484 remote node, and then resumed there. This all depends on the
1485 hypervisor support for two different methods. In any case, it is not
1486 an error to pass this parameter (it will just be ignored if the
1487 hypervisor doesn't support it). The option ``--migration-mode=live``
1488 option will request a fully-live migration. The default, when neither
1489 option is passed, depends on the hypervisor parameters (and can be
1490 viewed with the **gnt-cluster info** command).
1492 If the ``--cleanup`` option is passed, the operation changes from
1493 migration to attempting recovery from a failed previous migration. In
1494 this mode, Ganeti checks if the instance runs on the correct node (and
1495 updates its configuration if not) and ensures the instances's disks
1496 are configured correctly. In this mode, the ``--non-live`` option is
1499 The option ``-f`` will skip the prompting for confirmation.
1501 If ``--allow-failover`` is specified it tries to fallback to failover if
1502 it already can determine that a migration won't work (e.g. if the
1503 instance is shut down). Please note that the fallback will not happen
1504 during execution. If a migration fails during execution it still fails.
1506 If ``--ignore-ipolicy`` is given any instance policy violations occuring
1507 during this operation are ignored.
1509 The ``--no-runtime-changes`` option forbids migrate to alter an
1510 instance's runtime before migrating it (eg. ballooning an instance
1511 down because the target node doesn't have enough available memory).
1513 Example (and expected output)::
1515 # gnt-instance migrate instance1
1516 Instance instance1 will be migrated. Note that migration
1517 might impact the instance if anything goes wrong (e.g. due to bugs in
1518 the hypervisor). Continue?
1520 Migrating instance instance1.example.com
1521 * checking disk consistency between source and target
1522 * switching node node2.example.com to secondary mode
1523 * changing into standalone mode
1524 * changing disks into dual-master mode
1525 * wait until resync is done
1526 * preparing node2.example.com to accept the instance
1527 * migrating instance to node2.example.com
1528 * switching node node1.example.com to secondary mode
1529 * wait until resync is done
1530 * changing into standalone mode
1531 * changing disks into single-master mode
1532 * wait until resync is done
1540 **move** [-f] [\--ignore-consistency]
1541 [-n *node*] [\--shutdown-timeout=*N*] [\--submit] [\--ignore-ipolicy]
1544 Move will move the instance to an arbitrary node in the cluster. This
1545 works only for instances having a plain or file disk template.
1547 Note that since this operation is done via data copy, it will take a
1548 long time for big disks (similar to replace-disks for a drbd
1551 The ``--shutdown-timeout`` is used to specify how much time to wait
1552 before forcing the shutdown (e.g. ``xm destroy`` in XEN, killing the
1553 kvm process for KVM, etc.). By default two minutes are given to each
1556 The ``--ignore-consistency`` option will make Ganeti ignore any errors
1557 in trying to shutdown the instance on its node; useful if the
1558 hypervisor is broken and you want to recuperate the data.
1560 The ``--submit`` option is used to send the job to the master daemon
1561 but not wait for its completion. The job ID will be shown so that it
1562 can be examined via **gnt-job info**.
1564 If ``--ignore-ipolicy`` is given any instance policy violations occuring
1565 during this operation are ignored.
1569 # gnt-instance move -n node3.example.com instance1.example.com
1575 **change-group** [\--iallocator *NAME*] [\--to *GROUP*...] {*instance*}
1577 This command moves an instance to another node group. The move is
1578 calculated by an iallocator, either given on the command line or as a
1581 If no specific destination groups are specified using ``--to``, all
1582 groups except the one containing the instance are considered.
1586 # gnt-instance change-group -I hail --to rack2 inst1.example.com
1595 **add-tags** [\--from *file*] {*instancename*} {*tag*...}
1597 Add tags to the given instance. If any of the tags contains invalid
1598 characters, the entire operation will abort.
1600 If the ``--from`` option is given, the list of tags will be extended
1601 with the contents of that file (each line becomes a tag). In this
1602 case, there is not need to pass tags on the command line (if you do,
1603 both sources will be used). A file name of ``-`` will be interpreted
1609 **list-tags** {*instancename*}
1611 List the tags of the given instance.
1616 **remove-tags** [\--from *file*] {*instancename*} {*tag*...}
1618 Remove tags from the given instance. If any of the tags are not
1619 existing on the node, the entire operation will abort.
1621 If the ``--from`` option is given, the list of tags to be removed will
1622 be extended with the contents of that file (each line becomes a tag).
1623 In this case, there is not need to pass tags on the command line (if
1624 you do, tags from both sources will be removed). A file name of ``-``
1625 will be interpreted as stdin.
1627 .. vim: set textwidth=72 :