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}}
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*}
44 Creates a new instance on the specified host. The *instance* argument
45 must be in DNS, but depending on the bridge/routing setup, need not be
46 in the same network as the nodes in the cluster.
48 The ``disk`` option specifies the parameters for the disks of the
49 instance. The numbering of disks starts at zero, and at least one disk
50 needs to be passed. For each disk, either the size or the adoption
51 source needs to be given, and optionally the access mode (read-only or
52 the default of read-write) and the LVM volume group can also be
53 specified (via the ``vg`` key). For DRBD devices, a different VG can
54 be specified for the metadata device using the ``metavg`` key. The
55 size is interpreted (when no unit is given) in mebibytes. You can also
56 use one of the suffixes *m*, *g* or *t* to specify the exact the units
57 used; these suffixes map to mebibytes, gibibytes and tebibytes.
59 When using the ``adopt`` key in the disk definition, Ganeti will
60 reuse those volumes (instead of creating new ones) as the
61 instance's disks. Ganeti will rename these volumes to the standard
62 format, and (without installing the OS) will use them as-is for the
63 instance. This allows migrating instances from non-managed mode
64 (e.q. plain KVM with LVM) to being managed via Ganeti. Note that
65 this works only for the \`plain' disk template (see below for
68 Alternatively, a single-disk instance can be created via the ``-s``
69 option which takes a single argument, the size of the disk. This is
70 similar to the Ganeti 1.2 version (but will only create one disk).
72 The minimum disk specification is therefore ``--disk 0:size=20G`` (or
73 ``-s 20G`` when using the ``-s`` option), and a three-disk instance
74 can be specified as ``--disk 0:size=20G --disk 1:size=4G --disk
77 The ``--no-ip-check`` skips the checks that are done to see if the
78 instance's IP is not already alive (i.e. reachable from the master
81 The ``--no-name-check`` skips the check for the instance name via
82 the resolver (e.g. in DNS or /etc/hosts, depending on your setup).
83 Since the name check is used to compute the IP address, if you pass
84 this option you must also pass the ``--no-ip-check`` option.
86 If you don't wat the instance to automatically start after
87 creation, this is possible via the ``--no-start`` option. This will
88 leave the instance down until a subsequent **gnt-instance start**
91 The NICs of the instances can be specified via the ``--net``
92 option. By default, one NIC is created for the instance, with a
93 random MAC, and set up according the the cluster level nic
94 parameters. Each NIC can take these parameters (all optional):
97 either a value or 'generate' to generate a new unique MAC
100 specifies the IP address assigned to the instance from the Ganeti
101 side (this is not necessarily what the instance will use, but what
102 the node expects the instance to use)
105 specifies the connection mode for this nic: routed or bridged.
108 in bridged mode specifies the bridge to attach this NIC to, in
109 routed mode it's intended to differentiate between different
110 routing tables/instance groups (but the meaning is dependent on
111 the network script, see gnt-cluster(8) for more details)
114 Of these "mode" and "link" are nic parameters, and inherit their
115 default at cluster level. Alternatively, if no network is desired for
116 the instance, you can prevent the default of one NIC with the
117 ``--no-nics`` option.
119 The ``-o (--os-type)`` option specifies the operating system to be
120 installed. The available operating systems can be listed with
121 **gnt-os list**. Passing ``--no-install`` will however skip the OS
122 installation, allowing a manual import if so desired. Note that the
123 no-installation mode will automatically disable the start-up of the
124 instance (without an OS, it most likely won't be able to start-up
127 The ``-B (--backend-parameters)`` option specifies the backend
128 parameters for the instance. If no such parameters are specified, the
129 values are inherited from the cluster. Possible parameters are:
132 the memory size of the instance; as usual, suffixes can be used to
133 denote the unit, otherwise the value is taken in mebibites
136 the number of VCPUs to assign to the instance (if this value makes
137 sense for the hypervisor)
140 whether the instance is considered in the N+1 cluster checks
141 (enough redundancy in the cluster to survive a node failure)
144 The ``-H (--hypervisor-parameters)`` option specified the hypervisor
145 to use for the instance (must be one of the enabled hypervisors on the
146 cluster) and optionally custom parameters for this instance. If not
147 other options are used (i.e. the invocation is just -H *NAME*) the
148 instance will inherit the cluster options. The defaults below show the
149 cluster defaults at cluster creation time.
151 The possible hypervisor options are as follows:
154 Valid for the Xen HVM and KVM hypervisors.
156 A string value denoting the boot order. This has different meaning
157 for the Xen HVM hypervisor and for the KVM one.
159 For Xen HVM, The boot order is a string of letters listing the boot
160 devices, with valid device letters being:
174 The default is not to set an HVM boot order which is interpreted
177 For KVM the boot order is either "floppy", "cdrom", "disk" or
178 "network". Please note that older versions of KVM couldn't
179 netboot from virtio interfaces. This has been fixed in more recent
180 versions and is confirmed to work at least with qemu-kvm 0.11.1.
183 Valid for the Xen HVM and PVM hypervisors.
185 Relevant to non-pvops guest kernels, in which the disk device names
186 are given by the host. Allows one to specify 'xvd', which helps run
187 Red Hat based installers, driven by anaconda.
190 Valid for the KVM hypervisor.
192 The path to a floppy disk image to attach to the instance. This
193 is useful to install Windows operating systems on Virt/IO disks
194 because you can specify here the floppy for the drivers at
198 Valid for the Xen HVM and KVM hypervisors.
200 The path to a CDROM image to attach to the instance.
203 Valid for the KVM hypervisor.
205 The path to a second CDROM image to attach to the instance.
206 **NOTE**: This image can't be used to boot the system. To do that
207 you have to use the 'cdrom\_image\_path' option.
210 Valid for the Xen HVM and KVM hypervisors.
212 This parameter determines the way the network cards are presented
213 to the instance. The possible options are:
215 - rtl8139 (default for Xen HVM) (HVM & KVM)
216 - ne2k\_isa (HVM & KVM)
217 - ne2k\_pci (HVM & KVM)
223 - paravirtual (default for KVM) (HVM & KVM)
226 Valid for the Xen HVM and KVM hypervisors.
228 This parameter determines the way the disks are presented to the
229 instance. The possible options are:
231 - ioemu [default] (HVM & KVM)
240 Valid for the KVM hypervisor.
242 This parameter determines the way the cdroms disks are presented
243 to the instance. The default behavior is to get the same value of
244 the eariler parameter (disk_type). The possible options are:
255 Valid for the Xen HVM and KVM hypervisors.
257 Specifies the address that the VNC listener for this instance
258 should bind to. Valid values are IPv4 addresses. Use the address
259 0.0.0.0 to bind to all available interfaces (this is the default)
260 or specify the address of one of the interfaces on the node to
261 restrict listening to that interface.
264 Valid for the KVM hypervisor.
266 A boolean option that controls whether the VNC connection is
270 Valid for the KVM hypervisor.
272 If ``vnc_tls`` is enabled, this options specifies the path to the
273 x509 certificate to use.
276 Valid for the KVM hypervisor.
279 Valid for the KVM hypervisor.
281 Specifies the address or interface on which the SPICE server will
282 listen. Valid values are:
284 - IPv4 addresses, including 0.0.0.0 and 127.0.0.1
285 - IPv6 addresses, including :: and ::1
286 - names of network interfaces
288 If a network interface is specified, the SPICE server will be bound
289 to one of the addresses of that interface.
292 Valid for the KVM hypervisor.
294 Specifies which version of the IP protocol should be used by the
297 It is mainly intended to be used for specifying what kind of IP
298 addresses should be used if a network interface with both IPv4 and
299 IPv6 addresses is specified via the ``spice_bind`` parameter. In
300 this case, if the ``spice_ip_version`` parameter is not used, the
301 default IP version of the cluster will be used.
303 spice\_password\_file
304 Valid for the KVM hypervisor.
306 Specifies a file containing the password that must be used when
307 connecting via the SPICE protocol. If the option is not specified,
308 passwordless connections are allowed.
310 spice\_image\_compression
311 Valid for the KVM hypervisor.
313 Configures the SPICE lossless image compression. Valid values are:
322 spice\_jpeg\_wan\_compression
323 Valid for the KVM hypervisor.
325 Configures how SPICE should use the jpeg algorithm for lossy image
326 compression on slow links. Valid values are:
332 spice\_zlib\_glz\_wan\_compression
333 Valid for the KVM hypervisor.
335 Configures how SPICE should use the zlib-glz algorithm for lossy image
336 compression on slow links. Valid values are:
342 spice\_streaming\_video
343 Valid for the KVM hypervisor.
345 Configures how SPICE should detect video streams. Valid values are:
351 spice\_playback\_compression
352 Valid for the KVM hypervisor.
354 Configures whether SPICE should compress audio streams or not.
357 Valid for the Xen HVM and KVM hypervisors.
359 A boolean option that specifies if the hypervisor should enable
360 ACPI support for this instance. By default, ACPI is disabled.
363 Valid for the Xen HVM and KVM hypervisors.
365 A boolean option that specifies if the hypervisor should enabled
366 PAE support for this instance. The default is false, disabling PAE
370 Valid for the Xen HVM and KVM hypervisors.
372 A boolean option that specifies if the instance should be started
373 with its clock set to the localtime of the machine (when true) or
374 to the UTC (When false). The default is false, which is useful for
375 Linux/Unix machines; for Windows OSes, it is recommended to enable
379 Valid for the Xen PVM and KVM hypervisors.
381 This option specifies the path (on the node) to the kernel to boot
382 the instance with. Xen PVM instances always require this, while
383 for KVM if this option is empty, it will cause the machine to load
384 the kernel from its disks.
387 Valid for the Xen PVM and KVM hypervisors.
389 This options specifies extra arguments to the kernel that will be
390 loaded. device. This is always used for Xen PVM, while for KVM it
391 is only used if the ``kernel_path`` option is also specified.
393 The default setting for this value is simply ``"ro"``, which
394 mounts the root disk (initially) in read-only one. For example,
395 setting this to single will cause the instance to start in
399 Valid for the Xen PVM and KVM hypervisors.
401 This option specifies the path (on the node) to the initrd to boot
402 the instance with. Xen PVM instances can use this always, while
403 for KVM if this option is only used if the ``kernel_path`` option
404 is also specified. You can pass here either an absolute filename
405 (the path to the initrd) if you want to use an initrd, or use the
406 format no\_initrd\_path for no initrd.
409 Valid for the Xen PVM and KVM hypervisors.
411 This options specifies the name of the root device. This is always
412 needed for Xen PVM, while for KVM it is only used if the
413 ``kernel_path`` option is also specified.
415 Please note, that if this setting is an empty string and the
416 hypervisor is Xen it will not be written to the Xen configuration
420 Valid for the KVM hypervisor.
422 This boolean option specifies whether to emulate a serial console
426 Valid for the KVM hypervisor.
428 The disk cache mode. It can be either default to not pass any
429 cache option to KVM, or one of the KVM cache modes: none (for
430 direct I/O), writethrough (to use the host cache but report
431 completion to the guest only when the host has committed the
432 changes to disk) or writeback (to use the host cache and report
433 completion as soon as the data is in the host cache). Note that
434 there are special considerations for the cache mode depending on
435 version of KVM used and disk type (always raw file under Ganeti),
436 please refer to the KVM documentation for more details.
439 Valid for the KVM hypervisor.
441 The security model for kvm. Currently one of *none*, *user* or
442 *pool*. Under *none*, the default, nothing is done and instances
443 are run as the Ganeti daemon user (normally root).
445 Under *user* kvm will drop privileges and become the user
446 specified by the security\_domain parameter.
448 Under *pool* a global cluster pool of users will be used, making
449 sure no two instances share the same user on the same node. (this
450 mode is not implemented yet)
453 Valid for the KVM hypervisor.
455 Under security model *user* the username to run the instance
456 under. It must be a valid username existing on the host.
458 Cannot be set under security model *none* or *pool*.
461 Valid for the KVM hypervisor.
463 If *enabled* the -enable-kvm flag is passed to kvm. If *disabled*
464 -disable-kvm is passed. If unset no flag is passed, and the
465 default running mode for your kvm binary will be used.
468 Valid for the KVM hypervisor.
470 This option passes the -mem-path argument to kvm with the path (on
471 the node) to the mount point of the hugetlbfs file system, along
472 with the -mem-prealloc argument too.
475 Valid for the KVM hypervisor.
477 This boolean option determines wether to run the KVM instance in a
480 If it is set to ``true``, an empty directory is created before
481 starting the instance and its path is passed via the -chroot flag
482 to kvm. The directory is removed when the instance is stopped.
484 It is set to ``false`` by default.
487 Valid for the KVM hypervisor.
489 The maximum amount of time (in ms) a KVM instance is allowed to be
490 frozen during a live migration, in order to copy dirty memory
491 pages. Default value is 30ms, but you may need to increase this
492 value for busy instances.
494 This option is only effective with kvm versions >= 87 and qemu-kvm
498 Valid for the LXC hypervisor.
500 The processes belonging to the given instance are only scheduled
501 on the specified CPUs.
503 The parameter format is a comma-separated list of CPU IDs or CPU
504 ID ranges. The ranges are defined by a lower and higher boundary,
505 separated by a dash. The boundaries are inclusive.
508 Valid for the KVM hypervisor.
510 This option specifies the usb mouse type to be used. It can be
511 "mouse" or "tablet". When using VNC it's recommended to set it to
515 Valid for the KVM hypervisor.
517 This option specifies the keyboard mapping to be used. It is only
518 needed when using the VNC console. For example: "fr" or "en-gb".
521 Valid for Xen PVM, Xen HVM and KVM hypervisors.
523 Normally if an instance reboots, the hypervisor will restart it. If
524 this option is set to ``exit``, the hypervisor will treat a reboot
525 as a shutdown instead.
527 It is set to ``reboot`` by default.
530 The ``-O (--os-parameters)`` option allows customisation of the OS
531 parameters. The actual parameter names and values depends on the OS
532 being used, but the syntax is the same key=value. For example, setting
533 a hypothetical ``dhcp`` parameter to yes can be achieved by::
535 gnt-instance add -O dhcp=yes ...
537 The ``-I (--iallocator)`` option specifies the instance allocator
538 plugin to use. If you pass in this option the allocator will select
539 nodes for this instance automatically, so you don't need to pass them
540 with the ``-n`` option. For more information please refer to the
541 instance allocator documentation.
543 The ``-t (--disk-template)`` options specifies the disk layout type
544 for the instance. The available choices are:
547 This creates an instance with no disks. Its useful for testing only
548 (or other special cases).
551 Disk devices will be regular files.
554 Disk devices will be logical volumes.
557 Disk devices will be drbd (version 8.x) on top of lvm volumes.
560 The optional second value of the ``-n (--node)`` is used for the drbd
561 template type and specifies the remote node.
563 If you do not want gnt-instance to wait for the disk mirror to be
564 synced, use the ``--no-wait-for-sync`` option.
566 The ``--file-storage-dir`` specifies the relative path under the
567 cluster-wide file storage directory to store file-based disks. It is
568 useful for having different subdirectories for different
569 instances. The full path of the directory where the disk files are
570 stored will consist of cluster-wide file storage directory + optional
571 subdirectory + instance name. Example:
572 ``@RPL_FILE_STORAGE_DIR@``*/mysubdir/instance1.example.com*. This
573 option is only relevant for instances using the file storage backend.
575 The ``--file-driver`` specifies the driver to use for file-based
576 disks. Note that currently these drivers work with the xen hypervisor
577 only. This option is only relevant for instances using the file
578 storage backend. The available choices are:
581 Kernel loopback driver. This driver uses loopback devices to
582 access the filesystem within the file. However, running I/O
583 intensive applications in your instance using the loop driver
584 might result in slowdowns. Furthermore, if you use the loopback
585 driver consider increasing the maximum amount of loopback devices
586 (on most systems it's 8) using the max\_loop param.
589 The blktap driver (for Xen hypervisors). In order to be able to
590 use the blktap driver you should check if the 'blktapctrl' user
591 space disk agent is running (usually automatically started via
592 xend). This user-level disk I/O interface has the advantage of
593 better performance. Especially if you use a network file system
594 (e.g. NFS) to store your instances this is the recommended choice.
597 The ``--submit`` option is used to send the job to the master daemon
598 but not wait for its completion. The job ID will be shown so that it
599 can be examined via **gnt-job info**.
603 # gnt-instance add -t file --disk 0:size=30g -B memory=512 -o debian-etch \
604 -n node1.example.com --file-storage-dir=mysubdir instance1.example.com
605 # gnt-instance add -t plain --disk 0:size=30g -B memory=512 -o debian-etch \
606 -n node1.example.com instance1.example.com
607 # gnt-instance add -t plain --disk 0:size=30g --disk 1:size=100g,vg=san \
608 -B memory=512 -o debian-etch -n node1.example.com instance1.example.com
609 # gnt-instance add -t drbd --disk 0:size=30g -B memory=512 -o debian-etch \
610 -n node1.example.com:node2.example.com instance2.example.com
616 **batch-create** {instances\_file.json}
618 This command (similar to the Ganeti 1.2 **batcher** tool) submits
619 multiple instance creation jobs based on a definition file. The
620 instance configurations do not encompass all the possible options for
621 the **add** command, but only a subset.
623 The instance file should be a valid-formed JSON file, containing a
624 dictionary with instance name and instance parameters. The accepted
628 The size of the disks of the instance.
631 The disk template to use for the instance, the same as in the
635 A dictionary of backend parameters.
638 A dictionary with a single key (the hypervisor name), and as value
639 the hypervisor options. If not passed, the default hypervisor and
640 hypervisor options will be inherited.
643 Specifications for the one NIC that will be created for the
644 instance. 'bridge' is also accepted as a backwards compatibile
648 List of nics that will be created for the instance. Each entry
649 should be a dict, with mac, ip, mode and link as possible keys.
650 Please don't provide the "mac, ip, mode, link" parent keys if you
651 use this method for specifying nics.
653 primary\_node, secondary\_node
654 The primary and optionally the secondary node to use for the
655 instance (in case an iallocator script is not used).
658 Instead of specifying the nodes, an iallocator script can be used
659 to automatically compute them.
662 whether to start the instance
665 Skip the check for already-in-use instance; see the description in
666 the **add** command for details.
669 Skip the name check for instances; see the description in the
670 **add** command for details.
672 file\_storage\_dir, file\_driver
673 Configuration for the file disk type, see the **add** command for
677 A simple definition for one instance can be (with most of the
678 parameters taken from the cluster defaults)::
684 "disk_size": ["25G"],
690 "disk_size": ["25G"],
691 "iallocator": "dumb",
692 "hypervisor": "xen-hvm",
693 "hvparams": {"acpi": true},
694 "backend": {"memory": 512}
698 The command will display the job id for each submitted instance, as
701 # gnt-instance batch-create instances.json
708 **remove** [--ignore-failures] [--shutdown-timeout=*N*] [--submit]
709 [--force] {*instance*}
711 Remove an instance. This will remove all data from the instance and
712 there is *no way back*. If you are not sure if you use an instance
713 again, use **shutdown** first and leave it in the shutdown state for a
716 The ``--ignore-failures`` option will cause the removal to proceed
717 even in the presence of errors during the removal of the instance
718 (e.g. during the shutdown or the disk removal). If this option is not
719 given, the command will stop at the first error.
721 The ``--shutdown-timeout`` is used to specify how much time to wait
722 before forcing the shutdown (e.g. ``xm destroy`` in Xen, killing the
723 kvm process for KVM, etc.). By default two minutes are given to each
726 The ``--submit`` option is used to send the job to the master daemon
727 but not wait for its completion. The job ID will be shown so that it
728 can be examined via **gnt-job info**.
730 The ``--force`` option is used to skip the interactive confirmation.
734 # gnt-instance remove instance1.example.com
741 | [--no-headers] [--separator=*SEPARATOR*] [--units=*UNITS*] [-v]
742 | [{-o|--output} *[+]FIELD,...*] [--filter] [instance...]
744 Shows the currently configured instances with memory usage, disk
745 usage, the node they are running on, and their run status.
747 The ``--no-headers`` option will skip the initial header line. The
748 ``--separator`` option takes an argument which denotes what will be
749 used between the output fields. Both these options are to help
752 The units used to display the numeric values in the output varies,
753 depending on the options given. By default, the values will be
754 formatted in the most appropriate unit. If the ``--separator`` option
755 is given, then the values are shown in mebibytes to allow parsing by
756 scripts. In both cases, the ``--units`` option can be used to enforce
759 The ``-v`` option activates verbose mode, which changes the display of
760 special field states (see **ganeti(7)**).
762 The ``-o (--output)`` option takes a comma-separated list of output
763 fields. The available fields and their meaning are:
765 @QUERY_FIELDS_INSTANCE@
767 If the value of the option starts with the character ``+``, the new
768 field(s) will be added to the default list. This allows one to quickly
769 see the default list plus a few other fields, instead of retyping the
770 entire list of fields.
772 There is a subtle grouping about the available output fields: all
773 fields except for ``oper_state``, ``oper_ram``, ``oper_vcpus`` and
774 ``status`` are configuration value and not run-time values. So if you
775 don't select any of the these fields, the query will be satisfied
776 instantly from the cluster configuration, without having to ask the
777 remote nodes for the data. This can be helpful for big clusters when
778 you only want some data and it makes sense to specify a reduced set of
781 If exactly one argument is given and it appears to be a query filter
782 (see **ganeti(7)**), the query result is filtered accordingly. For
783 ambiguous cases (e.g. a single field name as a filter) the ``--filter``
784 (``-F``) option forces the argument to be treated as a filter (e.g.
785 ``gnt-instance list -F admin_state``).
787 The default output field list is: ``name``, ``os``, ``pnode``,
788 ``admin_state``, ``oper_state``, ``oper_ram``.
794 **list-fields** [field...]
796 Lists available fields for instances.
802 **info** [-s \| --static] [--roman] {--all \| *instance*}
804 Show detailed information about the given instance(s). This is
805 different from **list** as it shows detailed data about the instance's
806 disks (especially useful for the drbd disk template).
808 If the option ``-s`` is used, only information available in the
809 configuration file is returned, without querying nodes, making the
812 Use the ``--all`` to get info about all instances, rather than
813 explicitly passing the ones you're interested in.
815 The ``--roman`` option can be used to cause envy among people who like
816 ancient cultures, but are stuck with non-latin-friendly cluster
817 virtualization technologies.
823 | [{-H|--hypervisor-parameters} *HYPERVISOR\_PARAMETERS*]
824 | [{-B|--backend-parameters} *BACKEND\_PARAMETERS*]
825 | [--net add*[:options]* \| --net remove \| --net *N:options*]
826 | [--disk add:size=*SIZE*[,vg=*VG*][,metavg=*VG*] \| --disk remove \|
827 | --disk *N*:mode=*MODE*]
828 | [{-t|--disk-template} plain | {-t|--disk-template} drbd -n *new_secondary*] [--no-wait-for-sync]
829 | [--os-type=*OS* [--force-variant]]
830 | [{-O|--os-parameters} *param*=*value*... ]
834 Modifies the memory size, number of vcpus, ip address, MAC address
835 and/or nic parameters for an instance. It can also add and remove
836 disks and NICs to/from the instance. Note that you need to give at
837 least one of the arguments, otherwise the command complains.
839 The ``-H (--hypervisor-parameters)``, ``-B (--backend-parameters)``
840 and ``-O (--os-parameters)`` options specifies hypervisor, backend and
841 OS parameter options in the form of name=value[,...]. For details
842 which options can be specified, see the **add** command.
844 The ``-t (--disk-template)`` option will change the disk template of
845 the instance. Currently only conversions between the plain and drbd
846 disk templates are supported, and the instance must be stopped before
847 attempting the conversion. When changing from the plain to the drbd
848 disk template, a new secondary node must be specified via the ``-n``
849 option. The option ``--no-wait-for-sync`` can be used when converting
850 to the ``drbd`` template in order to make the instance available for
851 startup before DRBD has finished resyncing.
853 The ``--disk add:size=``*SIZE* option adds a disk to the instance. The
854 optional ``vg=``*VG* option specifies LVM volume group other than
855 default vg to create the disk on. For DRBD disks, the ``metavg=``*VG*
856 option specifies the volume group for the metadata device. The
857 ``--disk remove`` option will remove the last disk of the
858 instance. The ``--disk`` *N*``:mode=``*MODE* option will change the
859 mode of the Nth disk of the instance between read-only (``ro``) and
862 The ``--net add:``*options* option will add a new NIC to the
863 instance. The available options are the same as in the **add** command
864 (mac, ip, link, mode). The ``--net remove`` will remove the last NIC
865 of the instance, while the ``--net`` *N*:*options* option will change
866 the parameters of the Nth instance NIC.
868 The option ``-o (--os-type)`` will change the OS name for the instance
869 (without reinstallation). In case an OS variant is specified that is
870 not found, then by default the modification is refused, unless
871 ``--force-variant`` is passed. An invalid OS will also be refused,
872 unless the ``--force`` option is given.
874 The ``--submit`` option is used to send the job to the master daemon
875 but not wait for its completion. The job ID will be shown so that it
876 can be examined via **gnt-job info**.
878 All the changes take effect at the next restart. If the instance is
879 running, there is no effect on the instance.
884 | **reinstall** [{-o|--os-type} *os-type*] [--select-os] [-f *force*]
886 | [--instance \| --node \| --primary \| --secondary \| --all]
887 | [{-O|--os-parameters} *OS\_PARAMETERS*] [--submit] {*instance*...}
889 Reinstalls the operating system on the given instance(s). The
890 instance(s) must be stopped when running this command. If the ``-o
891 (--os-type)`` is specified, the operating system is changed.
893 The ``--select-os`` option switches to an interactive OS reinstall.
894 The user is prompted to select the OS template from the list of
895 available OS templates. OS parameters can be overridden using ``-O
896 (--os-parameters)`` (more documentation for this option under the
899 Since this is a potentially dangerous command, the user will be
900 required to confirm this action, unless the ``-f`` flag is passed.
901 When multiple instances are selected (either by passing multiple
902 arguments or by using the ``--node``, ``--primary``, ``--secondary``
903 or ``--all`` options), the user must pass the ``--force-multiple``
904 options to skip the interactive confirmation.
906 The ``--submit`` option is used to send the job to the master daemon
907 but not wait for its completion. The job ID will be shown so that it
908 can be examined via **gnt-job info**.
913 | **rename** [--no-ip-check] [--no-name-check] [--submit]
914 | {*instance*} {*new\_name*}
916 Renames the given instance. The instance must be stopped when running
917 this command. The requirements for the new name are the same as for
918 adding an instance: the new name must be resolvable and the IP it
919 resolves to must not be reachable (in order to prevent duplicate IPs
920 the next time the instance is started). The IP test can be skipped if
921 the ``--no-ip-check`` option is passed.
923 The ``--no-name-check`` skips the check for the new instance name via
924 the resolver (e.g. in DNS or /etc/hosts, depending on your setup) and
925 that the resolved name matches the provided name. Since the name check
926 is used to compute the IP address, if you pass this option you must also
927 pass the ``--no-ip-check`` option.
929 The ``--submit`` option is used to send the job to the master daemon
930 but not wait for its completion. The job ID will be shown so that it
931 can be examined via **gnt-job info**.
933 Starting/stopping/connecting to console
934 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
940 | [--force] [--ignore-offline]
941 | [--force-multiple] [--no-remember]
942 | [--instance \| --node \| --primary \| --secondary \| --all \|
943 | --tags \| --node-tags \| --pri-node-tags \| --sec-node-tags]
944 | [{-H|--hypervisor-parameters} ``key=value...``]
945 | [{-B|--backend-parameters} ``key=value...``]
946 | [--submit] [--paused]
949 Starts one or more instances, depending on the following options. The
950 four available modes are:
953 will start the instances given as arguments (at least one argument
954 required); this is the default selection
957 will start the instances who have the given node as either primary
961 will start all instances whose primary node is in the list of nodes
962 passed as arguments (at least one node required)
965 will start all instances whose secondary node is in the list of
966 nodes passed as arguments (at least one node required)
969 will start all instances in the cluster (no arguments accepted)
972 will start all instances in the cluster with the tags given as
976 will start all instances in the cluster on nodes with the tags
980 will start all instances in the cluster on primary nodes with the
981 tags given as arguments
984 will start all instances in the cluster on secondary nodes with the
985 tags given as arguments
987 Note that although you can pass more than one selection option, the
988 last one wins, so in order to guarantee the desired result, don't pass
989 more than one such option.
991 Use ``--force`` to start even if secondary disks are failing.
992 ``--ignore-offline`` can be used to ignore offline primary nodes and
993 mark the instance as started even if the primary is not available.
995 The ``--force-multiple`` will skip the interactive confirmation in the
996 case the more than one instance will be affected.
998 The ``--no-remember`` option will perform the startup but not change
999 the state of the instance in the configuration file (if it was stopped
1000 before, Ganeti will still thinks it needs to be stopped). This can be
1001 used for testing, or for a one shot-start where you don't want the
1002 watcher to restart the instance if it crashes.
1004 The ``-H (--hypervisor-parameters)`` and ``-B (--backend-parameters)``
1005 options specify temporary hypervisor and backend parameters that can
1006 be used to start an instance with modified parameters. They can be
1007 useful for quick testing without having to modify an instance back and
1010 # gnt-instance start -H kernel_args="single" instance1
1011 # gnt-instance start -B memory=2048 instance2
1014 The first form will start the instance instance1 in single-user mode,
1015 and the instance instance2 with 2GB of RAM (this time only, unless
1016 that is the actual instance memory size already). Note that the values
1017 override the instance parameters (and not extend them): an instance
1018 with "kernel\_args=ro" when started with -H kernel\_args=single will
1019 result in "single", not "ro single". The ``--submit`` option is used
1020 to send the job to the master daemon but not wait for its
1021 completion. The job ID will be shown so that it can be examined via
1024 The ``--paused`` option is only valid for Xen and kvm hypervisors. This
1025 pauses the instance at the start of bootup, awaiting ``gnt-instance
1026 console`` to unpause it, allowing the entire boot process to be
1027 monitored for debugging.
1031 # gnt-instance start instance1.example.com
1032 # gnt-instance start --node node1.example.com node2.example.com
1033 # gnt-instance start --all
1041 | [--force-multiple] [--ignore-offline] [--no-remember]
1042 | [--instance \| --node \| --primary \| --secondary \| --all \|
1043 | --tags \| --node-tags \| --pri-node-tags \| --sec-node-tags]
1047 Stops one or more instances. If the instance cannot be cleanly stopped
1048 during a hardcoded interval (currently 2 minutes), it will forcibly
1049 stop the instance (equivalent to switching off the power on a physical
1052 The ``--timeout`` is used to specify how much time to wait before
1053 forcing the shutdown (e.g. ``xm destroy`` in Xen, killing the kvm
1054 process for KVM, etc.). By default two minutes are given to each
1057 The ``--instance``, ``--node``, ``--primary``, ``--secondary``,
1058 ``--all``, ``--tags``, ``--node-tags``, ``--pri-node-tags`` and
1059 ``--sec-node-tags`` options are similar as for the **startup** command
1060 and they influence the actual instances being shutdown.
1062 The ``--submit`` option is used to send the job to the master daemon
1063 but not wait for its completion. The job ID will be shown so that it
1064 can be examined via **gnt-job info**.
1066 ``--ignore-offline`` can be used to ignore offline primary nodes and
1067 force the instance to be marked as stopped. This option should be used
1068 with care as it can lead to an inconsistent cluster state.
1070 The ``--no-remember`` option will perform the shutdown but not change
1071 the state of the instance in the configuration file (if it was running
1072 before, Ganeti will still thinks it needs to be running). This can be
1073 useful for a cluster-wide shutdown, where some instances are marked as
1074 up and some as down, and you don't want to change the running state:
1075 you just need to disable the watcher, shutdown all instances with
1076 ``--no-remember``, and when the watcher is activated again it will
1077 restore the correct runtime state for all instances.
1081 # gnt-instance shutdown instance1.example.com
1082 # gnt-instance shutdown --all
1089 | [{-t|--type} *REBOOT-TYPE*]
1090 | [--ignore-secondaries]
1091 | [--shutdown-timeout=*N*]
1092 | [--force-multiple]
1093 | [--instance \| --node \| --primary \| --secondary \| --all \|
1094 | --tags \| --node-tags \| --pri-node-tags \| --sec-node-tags]
1098 Reboots one or more instances. The type of reboot depends on the value
1099 of ``-t (--type)``. A soft reboot does a hypervisor reboot, a hard reboot
1100 does a instance stop, recreates the hypervisor config for the instance
1101 and starts the instance. A full reboot does the equivalent of
1102 **gnt-instance shutdown && gnt-instance startup**. The default is
1105 For the hard reboot the option ``--ignore-secondaries`` ignores errors
1106 for the secondary node while re-assembling the instance disks.
1108 The ``--instance``, ``--node``, ``--primary``, ``--secondary``,
1109 ``--all``, ``--tags``, ``--node-tags``, ``--pri-node-tags`` and
1110 ``--sec-node-tags`` options are similar as for the **startup** command
1111 and they influence the actual instances being rebooted.
1113 The ``--shutdown-timeout`` is used to specify how much time to wait
1114 before forcing the shutdown (xm destroy in xen, killing the kvm
1115 process, for kvm). By default two minutes are given to each instance
1118 The ``--force-multiple`` will skip the interactive confirmation in the
1119 case the more than one instance will be affected.
1123 # gnt-instance reboot instance1.example.com
1124 # gnt-instance reboot --type=full instance1.example.com
1130 **console** [--show-cmd] {*instance*}
1132 Connects to the console of the given instance. If the instance is not
1133 up, an error is returned. Use the ``--show-cmd`` option to display the
1134 command instead of executing it.
1136 For HVM instances, this will attempt to connect to the serial console
1137 of the instance. To connect to the virtualized "physical" console of a
1138 HVM instance, use a VNC client with the connection info from the
1141 For Xen/kvm instances, if the instance is paused, this attempts to
1142 unpause the instance after waiting a few seconds for the connection to
1143 the console to be made.
1147 # gnt-instance console instance1.example.com
1156 **replace-disks** [--submit] [--early-release] {-p} [--disks *idx*]
1159 **replace-disks** [--submit] [--early-release] {-s} [--disks *idx*]
1162 **replace-disks** [--submit] [--early-release] {--iallocator *name*
1163 \| --new-secondary *NODE*} {*instance*}
1165 **replace-disks** [--submit] [--early-release] {--auto}
1168 This command is a generalized form for replacing disks. It is
1169 currently only valid for the mirrored (DRBD) disk template.
1171 The first form (when passing the ``-p`` option) will replace the disks
1172 on the primary, while the second form (when passing the ``-s`` option
1173 will replace the disks on the secondary node. For these two cases (as
1174 the node doesn't change), it is possible to only run the replace for a
1175 subset of the disks, using the option ``--disks`` which takes a list
1176 of comma-delimited disk indices (zero-based), e.g. 0,2 to replace only
1177 the first and third disks.
1179 The third form (when passing either the ``--iallocator`` or the
1180 ``--new-secondary`` option) is designed to change secondary node of
1181 the instance. Specifying ``--iallocator`` makes the new secondary be
1182 selected automatically by the specified allocator plugin, otherwise
1183 the new secondary node will be the one chosen manually via the
1184 ``--new-secondary`` option.
1186 The fourth form (when using ``--auto``) will automatically determine
1187 which disks of an instance are faulty and replace them within the same
1188 node. The ``--auto`` option works only when an instance has only
1189 faulty disks on either the primary or secondary node; it doesn't work
1190 when both sides have faulty disks.
1192 The ``--submit`` option is used to send the job to the master daemon
1193 but not wait for its completion. The job ID will be shown so that it
1194 can be examined via **gnt-job info**.
1196 The ``--early-release`` changes the code so that the old storage on
1197 secondary node(s) is removed early (before the resync is completed)
1198 and the internal Ganeti locks for the current (and new, if any)
1199 secondary node are also released, thus allowing more parallelism in
1200 the cluster operation. This should be used only when recovering from a
1201 disk failure on the current secondary (thus the old storage is already
1202 broken) or when the storage on the primary node is known to be fine
1203 (thus we won't need the old storage for potential recovery).
1205 Note that it is not possible to select an offline or drained node as a
1211 **activate-disks** [--submit] [--ignore-size] {*instance*}
1213 Activates the block devices of the given instance. If successful, the
1214 command will show the location and name of the block devices::
1216 node1.example.com:disk/0:/dev/drbd0
1217 node1.example.com:disk/1:/dev/drbd1
1220 In this example, *node1.example.com* is the name of the node on which
1221 the devices have been activated. The *disk/0* and *disk/1* are the
1222 Ganeti-names of the instance disks; how they are visible inside the
1223 instance is hypervisor-specific. */dev/drbd0* and */dev/drbd1* are the
1224 actual block devices as visible on the node. The ``--submit`` option
1225 is used to send the job to the master daemon but not wait for its
1226 completion. The job ID will be shown so that it can be examined via
1229 The ``--ignore-size`` option can be used to activate disks ignoring
1230 the currently configured size in Ganeti. This can be used in cases
1231 where the configuration has gotten out of sync with the real-world
1232 (e.g. after a partially-failed grow-disk operation or due to rounding
1233 in LVM devices). This should not be used in normal cases, but only
1234 when activate-disks fails without it.
1236 Note that it is safe to run this command while the instance is already
1242 **deactivate-disks** [-f] [--submit] {*instance*}
1244 De-activates the block devices of the given instance. Note that if you
1245 run this command for an instance with a drbd disk template, while it
1246 is running, it will not be able to shutdown the block devices on the
1247 primary node, but it will shutdown the block devices on the secondary
1248 nodes, thus breaking the replication.
1250 The ``-f``/``--force`` option will skip checks that the instance is
1251 down; in case the hypervisor is confused and we can't talk to it,
1252 normally Ganeti will refuse to deactivate the disks, but with this
1253 option passed it will skip this check and directly try to deactivate
1254 the disks. This can still fail due to the instance actually running or
1257 The ``--submit`` option is used to send the job to the master daemon
1258 but not wait for its completion. The job ID will be shown so that it
1259 can be examined via **gnt-job info**.
1264 **grow-disk** [--no-wait-for-sync] [--submit] {*instance*} {*disk*}
1267 Grows an instance's disk. This is only possible for instances having a
1268 plain or drbd disk template.
1270 Note that this command only change the block device size; it will not
1271 grow the actual filesystems, partitions, etc. that live on that
1272 disk. Usually, you will need to:
1274 #. use **gnt-instance grow-disk**
1276 #. reboot the instance (later, at a convenient time)
1278 #. use a filesystem resizer, such as ext2online(8) or
1279 xfs\_growfs(8) to resize the filesystem, or use fdisk(8) to change
1280 the partition table on the disk
1282 The *disk* argument is the index of the instance disk to grow. The
1283 *amount* argument is given either as a number (and it represents the
1284 amount to increase the disk with in mebibytes) or can be given similar
1285 to the arguments in the create instance operation, with a suffix
1288 Note that the disk grow operation might complete on one node but fail
1289 on the other; this will leave the instance with different-sized LVs on
1290 the two nodes, but this will not create problems (except for unused
1293 If you do not want gnt-instance to wait for the new disk region to be
1294 synced, use the ``--no-wait-for-sync`` option.
1296 The ``--submit`` option is used to send the job to the master daemon
1297 but not wait for its completion. The job ID will be shown so that it
1298 can be examined via **gnt-job info**.
1300 Example (increase the first disk for instance1 by 16GiB)::
1302 # gnt-instance grow-disk instance1.example.com 0 16g
1305 Also note that disk shrinking is not supported; use **gnt-backup
1306 export** and then **gnt-backup import** to reduce the disk size of an
1312 **recreate-disks** [--submit] [--disks=``indices``] [-n node1:[node2]]
1315 Recreates the disks of the given instance, or only a subset of the
1316 disks (if the option ``disks`` is passed, which must be a
1317 comma-separated list of disk indices, starting from zero).
1319 Note that this functionality should only be used for missing disks; if
1320 any of the given disks already exists, the operation will fail. While
1321 this is suboptimal, recreate-disks should hopefully not be needed in
1322 normal operation and as such the impact of this is low.
1324 Optionally the instance's disks can be recreated on different
1325 nodes. This can be useful if, for example, the original nodes of the
1326 instance have gone down (and are marked offline), so we can't recreate
1327 on the same nodes. To do this, pass the new node(s) via ``-n`` option,
1328 with a syntax similar to the **add** command. The number of nodes
1329 passed must equal the number of nodes that the instance currently
1330 has. Note that changing nodes is only allowed for 'all disk'
1331 replacement (when ``--disks`` is not passed).
1333 The ``--submit`` option is used to send the job to the master daemon
1334 but not wait for its completion. The job ID will be shown so that it
1335 can be examined via **gnt-job info**.
1343 **failover** [-f] [--ignore-consistency] [--shutdown-timeout=*N*]
1344 [--submit] {*instance*}
1346 Failover will stop the instance (if running), change its primary node,
1347 and if it was originally running it will start it again (on the new
1348 primary). This only works for instances with drbd template (in which
1349 case you can only fail to the secondary node) and for externally
1350 mirrored templates (shared storage) (which can change to any other
1353 Normally the failover will check the consistency of the disks before
1354 failing over the instance. If you are trying to migrate instances off
1355 a dead node, this will fail. Use the ``--ignore-consistency`` option
1356 for this purpose. Note that this option can be dangerous as errors in
1357 shutting down the instance will be ignored, resulting in possibly
1358 having the instance running on two machines in parallel (on
1359 disconnected DRBD drives).
1361 The ``--shutdown-timeout`` is used to specify how much time to wait
1362 before forcing the shutdown (xm destroy in xen, killing the kvm
1363 process, for kvm). By default two minutes are given to each instance
1366 The ``--submit`` option is used to send the job to the master daemon
1367 but not wait for its completion. The job ID will be shown so that it
1368 can be examined via **gnt-job info**.
1372 # gnt-instance failover instance1.example.com
1378 **migrate** [-f] {--cleanup} {*instance*}
1380 **migrate** [-f] [--allow-failover] [--non-live]
1381 [--migration-mode=live\|non-live] {*instance*}
1383 Migrate will move the instance to its secondary node without
1384 shutdown. It only works for instances having the drbd8 disk template
1387 The migration command needs a perfectly healthy instance, as we rely
1388 on the dual-master capability of drbd8 and the disks of the instance
1389 are not allowed to be degraded.
1391 The ``--non-live`` and ``--migration-mode=non-live`` options will
1392 switch (for the hypervisors that support it) between a "fully live"
1393 (i.e. the interruption is as minimal as possible) migration and one in
1394 which the instance is frozen, its state saved and transported to the
1395 remote node, and then resumed there. This all depends on the
1396 hypervisor support for two different methods. In any case, it is not
1397 an error to pass this parameter (it will just be ignored if the
1398 hypervisor doesn't support it). The option ``--migration-mode=live``
1399 option will request a fully-live migration. The default, when neither
1400 option is passed, depends on the hypervisor parameters (and can be
1401 viewed with the **gnt-cluster info** command).
1403 If the ``--cleanup`` option is passed, the operation changes from
1404 migration to attempting recovery from a failed previous migration. In
1405 this mode, Ganeti checks if the instance runs on the correct node (and
1406 updates its configuration if not) and ensures the instances's disks
1407 are configured correctly. In this mode, the ``--non-live`` option is
1410 The option ``-f`` will skip the prompting for confirmation.
1412 If ``--allow-failover`` is specified it tries to fallback to failover if
1413 it already can determine that a migration wont work (i.e. if the
1414 instance is shutdown). Please note that the fallback will not happen
1415 during execution. If a migration fails during execution it still fails.
1417 Example (and expected output)::
1419 # gnt-instance migrate instance1
1420 Migrate will happen to the instance instance1. Note that migration is
1421 **experimental** in this version. This might impact the instance if
1422 anything goes wrong. Continue?
1424 * checking disk consistency between source and target
1425 * ensuring the target is in secondary mode
1426 * changing disks into dual-master mode
1427 - INFO: Waiting for instance instance1 to sync disks.
1428 - INFO: Instance instance1's disks are in sync.
1429 * migrating instance to node2.example.com
1430 * changing the instance's disks on source node to secondary
1431 - INFO: Waiting for instance instance1 to sync disks.
1432 - INFO: Instance instance1's disks are in sync.
1433 * changing the instance's disks to single-master
1440 **move** [-f] [--ignore-consistency]
1441 [-n *node*] [--shutdown-timeout=*N*] [--submit]
1444 Move will move the instance to an arbitrary node in the cluster. This
1445 works only for instances having a plain or file disk template.
1447 Note that since this operation is done via data copy, it will take a
1448 long time for big disks (similar to replace-disks for a drbd
1451 The ``--shutdown-timeout`` is used to specify how much time to wait
1452 before forcing the shutdown (e.g. ``xm destroy`` in XEN, killing the
1453 kvm process for KVM, etc.). By default two minutes are given to each
1456 The ``--ignore-consistency`` option will make Ganeti ignore any errors
1457 in trying to shutdown the instance on its node; useful if the
1458 hypervisor is broken and you want to recuperate the data.
1460 The ``--submit`` option is used to send the job to the master daemon
1461 but not wait for its completion. The job ID will be shown so that it
1462 can be examined via **gnt-job info**.
1466 # gnt-instance move -n node3.example.com instance1.example.com
1472 **change-group** [--iallocator *NAME*] [--to *GROUP*...] {*instance*}
1474 This command moves an instance to another node group. The move is
1475 calculated by an iallocator, either given on the command line or as a
1478 If no specific destination groups are specified using ``--to``, all
1479 groups except the one containing the instance are considered.
1483 # gnt-instance change-group -I hail --to rack2 inst1.example.com
1492 **add-tags** [--from *file*] {*instancename*} {*tag*...}
1494 Add tags to the given instance. If any of the tags contains invalid
1495 characters, the entire operation will abort.
1497 If the ``--from`` option is given, the list of tags will be extended
1498 with the contents of that file (each line becomes a tag). In this
1499 case, there is not need to pass tags on the command line (if you do,
1500 both sources will be used). A file name of ``-`` will be interpreted
1506 **list-tags** {*instancename*}
1508 List the tags of the given instance.
1513 **remove-tags** [--from *file*] {*instancename*} {*tag*...}
1515 Remove tags from the given instance. If any of the tags are not
1516 existing on the node, the entire operation will abort.
1518 If the ``--from`` option is given, the list of tags to be removed will
1519 be extended with the contents of that file (each line becomes a tag).
1520 In this case, there is not need to pass tags on the command line (if
1521 you do, tags from both sources will be removed). A file name of ``-``
1522 will be interpreted as stdin.
1524 .. vim: set textwidth=72 :