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 KVM hypervisor.
359 Specifies that the SPICE server must use TLS to encrypt all the
360 traffic with the client.
363 Valid for the KVM hypervisor.
365 Specifies a list of comma-separated ciphers that SPICE should use
366 for TLS connections. For the format, see man cipher(1).
369 Valid for the KVM hypervisor.
371 Enables or disables passing mouse events via SPICE vdagent.
374 Valid for the Xen HVM and KVM hypervisors.
376 A boolean option that specifies if the hypervisor should enable
377 ACPI support for this instance. By default, ACPI is disabled.
380 Valid for the Xen HVM and KVM hypervisors.
382 A boolean option that specifies if the hypervisor should enabled
383 PAE support for this instance. The default is false, disabling PAE
387 Valid for the Xen HVM and KVM hypervisors.
389 A boolean option that specifies if the instance should be started
390 with its clock set to the localtime of the machine (when true) or
391 to the UTC (When false). The default is false, which is useful for
392 Linux/Unix machines; for Windows OSes, it is recommended to enable
396 Valid for the Xen PVM and KVM hypervisors.
398 This option specifies the path (on the node) to the kernel to boot
399 the instance with. Xen PVM instances always require this, while
400 for KVM if this option is empty, it will cause the machine to load
401 the kernel from its disks.
404 Valid for the Xen PVM and KVM hypervisors.
406 This options specifies extra arguments to the kernel that will be
407 loaded. device. This is always used for Xen PVM, while for KVM it
408 is only used if the ``kernel_path`` option is also specified.
410 The default setting for this value is simply ``"ro"``, which
411 mounts the root disk (initially) in read-only one. For example,
412 setting this to single will cause the instance to start in
416 Valid for the Xen PVM and KVM hypervisors.
418 This option specifies the path (on the node) to the initrd to boot
419 the instance with. Xen PVM instances can use this always, while
420 for KVM if this option is only used if the ``kernel_path`` option
421 is also specified. You can pass here either an absolute filename
422 (the path to the initrd) if you want to use an initrd, or use the
423 format no\_initrd\_path for no initrd.
426 Valid for the Xen PVM and KVM hypervisors.
428 This options specifies the name of the root device. This is always
429 needed for Xen PVM, while for KVM it is only used if the
430 ``kernel_path`` option is also specified.
432 Please note, that if this setting is an empty string and the
433 hypervisor is Xen it will not be written to the Xen configuration
437 Valid for the KVM hypervisor.
439 This boolean option specifies whether to emulate a serial console
443 Valid for the KVM hypervisor.
445 The disk cache mode. It can be either default to not pass any
446 cache option to KVM, or one of the KVM cache modes: none (for
447 direct I/O), writethrough (to use the host cache but report
448 completion to the guest only when the host has committed the
449 changes to disk) or writeback (to use the host cache and report
450 completion as soon as the data is in the host cache). Note that
451 there are special considerations for the cache mode depending on
452 version of KVM used and disk type (always raw file under Ganeti),
453 please refer to the KVM documentation for more details.
456 Valid for the KVM hypervisor.
458 The security model for kvm. Currently one of *none*, *user* or
459 *pool*. Under *none*, the default, nothing is done and instances
460 are run as the Ganeti daemon user (normally root).
462 Under *user* kvm will drop privileges and become the user
463 specified by the security\_domain parameter.
465 Under *pool* a global cluster pool of users will be used, making
466 sure no two instances share the same user on the same node. (this
467 mode is not implemented yet)
470 Valid for the KVM hypervisor.
472 Under security model *user* the username to run the instance
473 under. It must be a valid username existing on the host.
475 Cannot be set under security model *none* or *pool*.
478 Valid for the KVM hypervisor.
480 If *enabled* the -enable-kvm flag is passed to kvm. If *disabled*
481 -disable-kvm is passed. If unset no flag is passed, and the
482 default running mode for your kvm binary will be used.
485 Valid for the KVM hypervisor.
487 This option passes the -mem-path argument to kvm with the path (on
488 the node) to the mount point of the hugetlbfs file system, along
489 with the -mem-prealloc argument too.
492 Valid for the KVM hypervisor.
494 This boolean option determines wether to run the KVM instance in a
497 If it is set to ``true``, an empty directory is created before
498 starting the instance and its path is passed via the -chroot flag
499 to kvm. The directory is removed when the instance is stopped.
501 It is set to ``false`` by default.
504 Valid for the KVM hypervisor.
506 The maximum amount of time (in ms) a KVM instance is allowed to be
507 frozen during a live migration, in order to copy dirty memory
508 pages. Default value is 30ms, but you may need to increase this
509 value for busy instances.
511 This option is only effective with kvm versions >= 87 and qemu-kvm
515 Valid for the LXC hypervisor.
517 The processes belonging to the given instance are only scheduled
518 on the specified CPUs.
520 The parameter format is a comma-separated list of CPU IDs or CPU
521 ID ranges. The ranges are defined by a lower and higher boundary,
522 separated by a dash. The boundaries are inclusive.
525 Valid for the KVM hypervisor.
527 This option specifies the usb mouse type to be used. It can be
528 "mouse" or "tablet". When using VNC it's recommended to set it to
532 Valid for the KVM hypervisor.
534 This option specifies the keyboard mapping to be used. It is only
535 needed when using the VNC console. For example: "fr" or "en-gb".
538 Valid for Xen PVM, Xen HVM and KVM hypervisors.
540 Normally if an instance reboots, the hypervisor will restart it. If
541 this option is set to ``exit``, the hypervisor will treat a reboot
542 as a shutdown instead.
544 It is set to ``reboot`` by default.
547 The ``-O (--os-parameters)`` option allows customisation of the OS
548 parameters. The actual parameter names and values depends on the OS
549 being used, but the syntax is the same key=value. For example, setting
550 a hypothetical ``dhcp`` parameter to yes can be achieved by::
552 gnt-instance add -O dhcp=yes ...
554 The ``-I (--iallocator)`` option specifies the instance allocator
555 plugin to use. If you pass in this option the allocator will select
556 nodes for this instance automatically, so you don't need to pass them
557 with the ``-n`` option. For more information please refer to the
558 instance allocator documentation.
560 The ``-t (--disk-template)`` options specifies the disk layout type
561 for the instance. The available choices are:
564 This creates an instance with no disks. Its useful for testing only
565 (or other special cases).
568 Disk devices will be regular files.
571 Disk devices will be logical volumes.
574 Disk devices will be drbd (version 8.x) on top of lvm volumes.
577 The optional second value of the ``-n (--node)`` is used for the drbd
578 template type and specifies the remote node.
580 If you do not want gnt-instance to wait for the disk mirror to be
581 synced, use the ``--no-wait-for-sync`` option.
583 The ``--file-storage-dir`` specifies the relative path under the
584 cluster-wide file storage directory to store file-based disks. It is
585 useful for having different subdirectories for different
586 instances. The full path of the directory where the disk files are
587 stored will consist of cluster-wide file storage directory + optional
588 subdirectory + instance name. Example:
589 ``@RPL_FILE_STORAGE_DIR@``*/mysubdir/instance1.example.com*. This
590 option is only relevant for instances using the file storage backend.
592 The ``--file-driver`` specifies the driver to use for file-based
593 disks. Note that currently these drivers work with the xen hypervisor
594 only. This option is only relevant for instances using the file
595 storage backend. The available choices are:
598 Kernel loopback driver. This driver uses loopback devices to
599 access the filesystem within the file. However, running I/O
600 intensive applications in your instance using the loop driver
601 might result in slowdowns. Furthermore, if you use the loopback
602 driver consider increasing the maximum amount of loopback devices
603 (on most systems it's 8) using the max\_loop param.
606 The blktap driver (for Xen hypervisors). In order to be able to
607 use the blktap driver you should check if the 'blktapctrl' user
608 space disk agent is running (usually automatically started via
609 xend). This user-level disk I/O interface has the advantage of
610 better performance. Especially if you use a network file system
611 (e.g. NFS) to store your instances this is the recommended choice.
614 The ``--submit`` option is used to send the job to the master daemon
615 but not wait for its completion. The job ID will be shown so that it
616 can be examined via **gnt-job info**.
620 # gnt-instance add -t file --disk 0:size=30g -B memory=512 -o debian-etch \
621 -n node1.example.com --file-storage-dir=mysubdir instance1.example.com
622 # gnt-instance add -t plain --disk 0:size=30g -B memory=512 -o debian-etch \
623 -n node1.example.com instance1.example.com
624 # gnt-instance add -t plain --disk 0:size=30g --disk 1:size=100g,vg=san \
625 -B memory=512 -o debian-etch -n node1.example.com instance1.example.com
626 # gnt-instance add -t drbd --disk 0:size=30g -B memory=512 -o debian-etch \
627 -n node1.example.com:node2.example.com instance2.example.com
633 **batch-create** {instances\_file.json}
635 This command (similar to the Ganeti 1.2 **batcher** tool) submits
636 multiple instance creation jobs based on a definition file. The
637 instance configurations do not encompass all the possible options for
638 the **add** command, but only a subset.
640 The instance file should be a valid-formed JSON file, containing a
641 dictionary with instance name and instance parameters. The accepted
645 The size of the disks of the instance.
648 The disk template to use for the instance, the same as in the
652 A dictionary of backend parameters.
655 A dictionary with a single key (the hypervisor name), and as value
656 the hypervisor options. If not passed, the default hypervisor and
657 hypervisor options will be inherited.
660 Specifications for the one NIC that will be created for the
661 instance. 'bridge' is also accepted as a backwards compatibile
665 List of nics that will be created for the instance. Each entry
666 should be a dict, with mac, ip, mode and link as possible keys.
667 Please don't provide the "mac, ip, mode, link" parent keys if you
668 use this method for specifying nics.
670 primary\_node, secondary\_node
671 The primary and optionally the secondary node to use for the
672 instance (in case an iallocator script is not used).
675 Instead of specifying the nodes, an iallocator script can be used
676 to automatically compute them.
679 whether to start the instance
682 Skip the check for already-in-use instance; see the description in
683 the **add** command for details.
686 Skip the name check for instances; see the description in the
687 **add** command for details.
689 file\_storage\_dir, file\_driver
690 Configuration for the file disk type, see the **add** command for
694 A simple definition for one instance can be (with most of the
695 parameters taken from the cluster defaults)::
701 "disk_size": ["25G"],
707 "disk_size": ["25G"],
708 "iallocator": "dumb",
709 "hypervisor": "xen-hvm",
710 "hvparams": {"acpi": true},
711 "backend": {"memory": 512}
715 The command will display the job id for each submitted instance, as
718 # gnt-instance batch-create instances.json
725 **remove** [--ignore-failures] [--shutdown-timeout=*N*] [--submit]
726 [--force] {*instance*}
728 Remove an instance. This will remove all data from the instance and
729 there is *no way back*. If you are not sure if you use an instance
730 again, use **shutdown** first and leave it in the shutdown state for a
733 The ``--ignore-failures`` option will cause the removal to proceed
734 even in the presence of errors during the removal of the instance
735 (e.g. during the shutdown or the disk removal). If this option is not
736 given, the command will stop at the first error.
738 The ``--shutdown-timeout`` is used to specify how much time to wait
739 before forcing the shutdown (e.g. ``xm destroy`` in Xen, killing the
740 kvm process for KVM, etc.). By default two minutes are given to each
743 The ``--submit`` option is used to send the job to the master daemon
744 but not wait for its completion. The job ID will be shown so that it
745 can be examined via **gnt-job info**.
747 The ``--force`` option is used to skip the interactive confirmation.
751 # gnt-instance remove instance1.example.com
758 | [--no-headers] [--separator=*SEPARATOR*] [--units=*UNITS*] [-v]
759 | [{-o|--output} *[+]FIELD,...*] [--filter] [instance...]
761 Shows the currently configured instances with memory usage, disk
762 usage, the node they are running on, and their run status.
764 The ``--no-headers`` option will skip the initial header line. The
765 ``--separator`` option takes an argument which denotes what will be
766 used between the output fields. Both these options are to help
769 The units used to display the numeric values in the output varies,
770 depending on the options given. By default, the values will be
771 formatted in the most appropriate unit. If the ``--separator`` option
772 is given, then the values are shown in mebibytes to allow parsing by
773 scripts. In both cases, the ``--units`` option can be used to enforce
776 The ``-v`` option activates verbose mode, which changes the display of
777 special field states (see **ganeti(7)**).
779 The ``-o (--output)`` option takes a comma-separated list of output
780 fields. The available fields and their meaning are:
782 @QUERY_FIELDS_INSTANCE@
784 If the value of the option starts with the character ``+``, the new
785 field(s) will be added to the default list. This allows one to quickly
786 see the default list plus a few other fields, instead of retyping the
787 entire list of fields.
789 There is a subtle grouping about the available output fields: all
790 fields except for ``oper_state``, ``oper_ram``, ``oper_vcpus`` and
791 ``status`` are configuration value and not run-time values. So if you
792 don't select any of the these fields, the query will be satisfied
793 instantly from the cluster configuration, without having to ask the
794 remote nodes for the data. This can be helpful for big clusters when
795 you only want some data and it makes sense to specify a reduced set of
798 If exactly one argument is given and it appears to be a query filter
799 (see **ganeti(7)**), the query result is filtered accordingly. For
800 ambiguous cases (e.g. a single field name as a filter) the ``--filter``
801 (``-F``) option forces the argument to be treated as a filter (e.g.
802 ``gnt-instance list -F admin_state``).
804 The default output field list is: ``name``, ``os``, ``pnode``,
805 ``admin_state``, ``oper_state``, ``oper_ram``.
811 **list-fields** [field...]
813 Lists available fields for instances.
819 **info** [-s \| --static] [--roman] {--all \| *instance*}
821 Show detailed information about the given instance(s). This is
822 different from **list** as it shows detailed data about the instance's
823 disks (especially useful for the drbd disk template).
825 If the option ``-s`` is used, only information available in the
826 configuration file is returned, without querying nodes, making the
829 Use the ``--all`` to get info about all instances, rather than
830 explicitly passing the ones you're interested in.
832 The ``--roman`` option can be used to cause envy among people who like
833 ancient cultures, but are stuck with non-latin-friendly cluster
834 virtualization technologies.
840 | [{-H|--hypervisor-parameters} *HYPERVISOR\_PARAMETERS*]
841 | [{-B|--backend-parameters} *BACKEND\_PARAMETERS*]
842 | [--net add*[:options]* \| --net remove \| --net *N:options*]
843 | [--disk add:size=*SIZE*[,vg=*VG*][,metavg=*VG*] \| --disk remove \|
844 | --disk *N*:mode=*MODE*]
845 | [{-t|--disk-template} plain | {-t|--disk-template} drbd -n *new_secondary*] [--no-wait-for-sync]
846 | [--os-type=*OS* [--force-variant]]
847 | [{-O|--os-parameters} *param*=*value*... ]
851 Modifies the memory size, number of vcpus, ip address, MAC address
852 and/or nic parameters for an instance. It can also add and remove
853 disks and NICs to/from the instance. Note that you need to give at
854 least one of the arguments, otherwise the command complains.
856 The ``-H (--hypervisor-parameters)``, ``-B (--backend-parameters)``
857 and ``-O (--os-parameters)`` options specifies hypervisor, backend and
858 OS parameter options in the form of name=value[,...]. For details
859 which options can be specified, see the **add** command.
861 The ``-t (--disk-template)`` option will change the disk template of
862 the instance. Currently only conversions between the plain and drbd
863 disk templates are supported, and the instance must be stopped before
864 attempting the conversion. When changing from the plain to the drbd
865 disk template, a new secondary node must be specified via the ``-n``
866 option. The option ``--no-wait-for-sync`` can be used when converting
867 to the ``drbd`` template in order to make the instance available for
868 startup before DRBD has finished resyncing.
870 The ``--disk add:size=``*SIZE* option adds a disk to the instance. The
871 optional ``vg=``*VG* option specifies LVM volume group other than
872 default vg to create the disk on. For DRBD disks, the ``metavg=``*VG*
873 option specifies the volume group for the metadata device. The
874 ``--disk remove`` option will remove the last disk of the
875 instance. The ``--disk`` *N*``:mode=``*MODE* option will change the
876 mode of the Nth disk of the instance between read-only (``ro``) and
879 The ``--net add:``*options* option will add a new NIC to the
880 instance. The available options are the same as in the **add** command
881 (mac, ip, link, mode). The ``--net remove`` will remove the last NIC
882 of the instance, while the ``--net`` *N*:*options* option will change
883 the parameters of the Nth instance NIC.
885 The option ``-o (--os-type)`` will change the OS name for the instance
886 (without reinstallation). In case an OS variant is specified that is
887 not found, then by default the modification is refused, unless
888 ``--force-variant`` is passed. An invalid OS will also be refused,
889 unless the ``--force`` option is given.
891 The ``--submit`` option is used to send the job to the master daemon
892 but not wait for its completion. The job ID will be shown so that it
893 can be examined via **gnt-job info**.
895 All the changes take effect at the next restart. If the instance is
896 running, there is no effect on the instance.
901 | **reinstall** [{-o|--os-type} *os-type*] [--select-os] [-f *force*]
903 | [--instance \| --node \| --primary \| --secondary \| --all]
904 | [{-O|--os-parameters} *OS\_PARAMETERS*] [--submit] {*instance*...}
906 Reinstalls the operating system on the given instance(s). The
907 instance(s) must be stopped when running this command. If the ``-o
908 (--os-type)`` is specified, the operating system is changed.
910 The ``--select-os`` option switches to an interactive OS reinstall.
911 The user is prompted to select the OS template from the list of
912 available OS templates. OS parameters can be overridden using ``-O
913 (--os-parameters)`` (more documentation for this option under the
916 Since this is a potentially dangerous command, the user will be
917 required to confirm this action, unless the ``-f`` flag is passed.
918 When multiple instances are selected (either by passing multiple
919 arguments or by using the ``--node``, ``--primary``, ``--secondary``
920 or ``--all`` options), the user must pass the ``--force-multiple``
921 options to skip the interactive confirmation.
923 The ``--submit`` option is used to send the job to the master daemon
924 but not wait for its completion. The job ID will be shown so that it
925 can be examined via **gnt-job info**.
930 | **rename** [--no-ip-check] [--no-name-check] [--submit]
931 | {*instance*} {*new\_name*}
933 Renames the given instance. The instance must be stopped when running
934 this command. The requirements for the new name are the same as for
935 adding an instance: the new name must be resolvable and the IP it
936 resolves to must not be reachable (in order to prevent duplicate IPs
937 the next time the instance is started). The IP test can be skipped if
938 the ``--no-ip-check`` option is passed.
940 The ``--no-name-check`` skips the check for the new instance name via
941 the resolver (e.g. in DNS or /etc/hosts, depending on your setup) and
942 that the resolved name matches the provided name. Since the name check
943 is used to compute the IP address, if you pass this option you must also
944 pass the ``--no-ip-check`` option.
946 The ``--submit`` option is used to send the job to the master daemon
947 but not wait for its completion. The job ID will be shown so that it
948 can be examined via **gnt-job info**.
950 Starting/stopping/connecting to console
951 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
957 | [--force] [--ignore-offline]
958 | [--force-multiple] [--no-remember]
959 | [--instance \| --node \| --primary \| --secondary \| --all \|
960 | --tags \| --node-tags \| --pri-node-tags \| --sec-node-tags]
961 | [{-H|--hypervisor-parameters} ``key=value...``]
962 | [{-B|--backend-parameters} ``key=value...``]
963 | [--submit] [--paused]
966 Starts one or more instances, depending on the following options. The
967 four available modes are:
970 will start the instances given as arguments (at least one argument
971 required); this is the default selection
974 will start the instances who have the given node as either primary
978 will start all instances whose primary node is in the list of nodes
979 passed as arguments (at least one node required)
982 will start all instances whose secondary node is in the list of
983 nodes passed as arguments (at least one node required)
986 will start all instances in the cluster (no arguments accepted)
989 will start all instances in the cluster with the tags given as
993 will start all instances in the cluster on nodes with the tags
997 will start all instances in the cluster on primary nodes with the
998 tags given as arguments
1001 will start all instances in the cluster on secondary nodes with the
1002 tags given as arguments
1004 Note that although you can pass more than one selection option, the
1005 last one wins, so in order to guarantee the desired result, don't pass
1006 more than one such option.
1008 Use ``--force`` to start even if secondary disks are failing.
1009 ``--ignore-offline`` can be used to ignore offline primary nodes and
1010 mark the instance as started even if the primary is not available.
1012 The ``--force-multiple`` will skip the interactive confirmation in the
1013 case the more than one instance will be affected.
1015 The ``--no-remember`` option will perform the startup but not change
1016 the state of the instance in the configuration file (if it was stopped
1017 before, Ganeti will still thinks it needs to be stopped). This can be
1018 used for testing, or for a one shot-start where you don't want the
1019 watcher to restart the instance if it crashes.
1021 The ``-H (--hypervisor-parameters)`` and ``-B (--backend-parameters)``
1022 options specify temporary hypervisor and backend parameters that can
1023 be used to start an instance with modified parameters. They can be
1024 useful for quick testing without having to modify an instance back and
1027 # gnt-instance start -H kernel_args="single" instance1
1028 # gnt-instance start -B memory=2048 instance2
1031 The first form will start the instance instance1 in single-user mode,
1032 and the instance instance2 with 2GB of RAM (this time only, unless
1033 that is the actual instance memory size already). Note that the values
1034 override the instance parameters (and not extend them): an instance
1035 with "kernel\_args=ro" when started with -H kernel\_args=single will
1036 result in "single", not "ro single". The ``--submit`` option is used
1037 to send the job to the master daemon but not wait for its
1038 completion. The job ID will be shown so that it can be examined via
1041 The ``--paused`` option is only valid for Xen and kvm hypervisors. This
1042 pauses the instance at the start of bootup, awaiting ``gnt-instance
1043 console`` to unpause it, allowing the entire boot process to be
1044 monitored for debugging.
1048 # gnt-instance start instance1.example.com
1049 # gnt-instance start --node node1.example.com node2.example.com
1050 # gnt-instance start --all
1058 | [--force-multiple] [--ignore-offline] [--no-remember]
1059 | [--instance \| --node \| --primary \| --secondary \| --all \|
1060 | --tags \| --node-tags \| --pri-node-tags \| --sec-node-tags]
1064 Stops one or more instances. If the instance cannot be cleanly stopped
1065 during a hardcoded interval (currently 2 minutes), it will forcibly
1066 stop the instance (equivalent to switching off the power on a physical
1069 The ``--timeout`` is used to specify how much time to wait before
1070 forcing the shutdown (e.g. ``xm destroy`` in Xen, killing the kvm
1071 process for KVM, etc.). By default two minutes are given to each
1074 The ``--instance``, ``--node``, ``--primary``, ``--secondary``,
1075 ``--all``, ``--tags``, ``--node-tags``, ``--pri-node-tags`` and
1076 ``--sec-node-tags`` options are similar as for the **startup** command
1077 and they influence the actual instances being shutdown.
1079 The ``--submit`` option is used to send the job to the master daemon
1080 but not wait for its completion. The job ID will be shown so that it
1081 can be examined via **gnt-job info**.
1083 ``--ignore-offline`` can be used to ignore offline primary nodes and
1084 force the instance to be marked as stopped. This option should be used
1085 with care as it can lead to an inconsistent cluster state.
1087 The ``--no-remember`` option will perform the shutdown but not change
1088 the state of the instance in the configuration file (if it was running
1089 before, Ganeti will still thinks it needs to be running). This can be
1090 useful for a cluster-wide shutdown, where some instances are marked as
1091 up and some as down, and you don't want to change the running state:
1092 you just need to disable the watcher, shutdown all instances with
1093 ``--no-remember``, and when the watcher is activated again it will
1094 restore the correct runtime state for all instances.
1098 # gnt-instance shutdown instance1.example.com
1099 # gnt-instance shutdown --all
1106 | [{-t|--type} *REBOOT-TYPE*]
1107 | [--ignore-secondaries]
1108 | [--shutdown-timeout=*N*]
1109 | [--force-multiple]
1110 | [--instance \| --node \| --primary \| --secondary \| --all \|
1111 | --tags \| --node-tags \| --pri-node-tags \| --sec-node-tags]
1115 Reboots one or more instances. The type of reboot depends on the value
1116 of ``-t (--type)``. A soft reboot does a hypervisor reboot, a hard reboot
1117 does a instance stop, recreates the hypervisor config for the instance
1118 and starts the instance. A full reboot does the equivalent of
1119 **gnt-instance shutdown && gnt-instance startup**. The default is
1122 For the hard reboot the option ``--ignore-secondaries`` ignores errors
1123 for the secondary node while re-assembling the instance disks.
1125 The ``--instance``, ``--node``, ``--primary``, ``--secondary``,
1126 ``--all``, ``--tags``, ``--node-tags``, ``--pri-node-tags`` and
1127 ``--sec-node-tags`` options are similar as for the **startup** command
1128 and they influence the actual instances being rebooted.
1130 The ``--shutdown-timeout`` is used to specify how much time to wait
1131 before forcing the shutdown (xm destroy in xen, killing the kvm
1132 process, for kvm). By default two minutes are given to each instance
1135 The ``--force-multiple`` will skip the interactive confirmation in the
1136 case the more than one instance will be affected.
1140 # gnt-instance reboot instance1.example.com
1141 # gnt-instance reboot --type=full instance1.example.com
1147 **console** [--show-cmd] {*instance*}
1149 Connects to the console of the given instance. If the instance is not
1150 up, an error is returned. Use the ``--show-cmd`` option to display the
1151 command instead of executing it.
1153 For HVM instances, this will attempt to connect to the serial console
1154 of the instance. To connect to the virtualized "physical" console of a
1155 HVM instance, use a VNC client with the connection info from the
1158 For Xen/kvm instances, if the instance is paused, this attempts to
1159 unpause the instance after waiting a few seconds for the connection to
1160 the console to be made.
1164 # gnt-instance console instance1.example.com
1173 **replace-disks** [--submit] [--early-release] {-p} [--disks *idx*]
1176 **replace-disks** [--submit] [--early-release] {-s} [--disks *idx*]
1179 **replace-disks** [--submit] [--early-release] {--iallocator *name*
1180 \| --new-secondary *NODE*} {*instance*}
1182 **replace-disks** [--submit] [--early-release] {--auto}
1185 This command is a generalized form for replacing disks. It is
1186 currently only valid for the mirrored (DRBD) disk template.
1188 The first form (when passing the ``-p`` option) will replace the disks
1189 on the primary, while the second form (when passing the ``-s`` option
1190 will replace the disks on the secondary node. For these two cases (as
1191 the node doesn't change), it is possible to only run the replace for a
1192 subset of the disks, using the option ``--disks`` which takes a list
1193 of comma-delimited disk indices (zero-based), e.g. 0,2 to replace only
1194 the first and third disks.
1196 The third form (when passing either the ``--iallocator`` or the
1197 ``--new-secondary`` option) is designed to change secondary node of
1198 the instance. Specifying ``--iallocator`` makes the new secondary be
1199 selected automatically by the specified allocator plugin, otherwise
1200 the new secondary node will be the one chosen manually via the
1201 ``--new-secondary`` option.
1203 The fourth form (when using ``--auto``) will automatically determine
1204 which disks of an instance are faulty and replace them within the same
1205 node. The ``--auto`` option works only when an instance has only
1206 faulty disks on either the primary or secondary node; it doesn't work
1207 when both sides have faulty disks.
1209 The ``--submit`` option is used to send the job to the master daemon
1210 but not wait for its completion. The job ID will be shown so that it
1211 can be examined via **gnt-job info**.
1213 The ``--early-release`` changes the code so that the old storage on
1214 secondary node(s) is removed early (before the resync is completed)
1215 and the internal Ganeti locks for the current (and new, if any)
1216 secondary node are also released, thus allowing more parallelism in
1217 the cluster operation. This should be used only when recovering from a
1218 disk failure on the current secondary (thus the old storage is already
1219 broken) or when the storage on the primary node is known to be fine
1220 (thus we won't need the old storage for potential recovery).
1222 Note that it is not possible to select an offline or drained node as a
1228 **activate-disks** [--submit] [--ignore-size] {*instance*}
1230 Activates the block devices of the given instance. If successful, the
1231 command will show the location and name of the block devices::
1233 node1.example.com:disk/0:/dev/drbd0
1234 node1.example.com:disk/1:/dev/drbd1
1237 In this example, *node1.example.com* is the name of the node on which
1238 the devices have been activated. The *disk/0* and *disk/1* are the
1239 Ganeti-names of the instance disks; how they are visible inside the
1240 instance is hypervisor-specific. */dev/drbd0* and */dev/drbd1* are the
1241 actual block devices as visible on the node. The ``--submit`` option
1242 is used to send the job to the master daemon but not wait for its
1243 completion. The job ID will be shown so that it can be examined via
1246 The ``--ignore-size`` option can be used to activate disks ignoring
1247 the currently configured size in Ganeti. This can be used in cases
1248 where the configuration has gotten out of sync with the real-world
1249 (e.g. after a partially-failed grow-disk operation or due to rounding
1250 in LVM devices). This should not be used in normal cases, but only
1251 when activate-disks fails without it.
1253 Note that it is safe to run this command while the instance is already
1259 **deactivate-disks** [-f] [--submit] {*instance*}
1261 De-activates the block devices of the given instance. Note that if you
1262 run this command for an instance with a drbd disk template, while it
1263 is running, it will not be able to shutdown the block devices on the
1264 primary node, but it will shutdown the block devices on the secondary
1265 nodes, thus breaking the replication.
1267 The ``-f``/``--force`` option will skip checks that the instance is
1268 down; in case the hypervisor is confused and we can't talk to it,
1269 normally Ganeti will refuse to deactivate the disks, but with this
1270 option passed it will skip this check and directly try to deactivate
1271 the disks. This can still fail due to the instance actually running or
1274 The ``--submit`` option is used to send the job to the master daemon
1275 but not wait for its completion. The job ID will be shown so that it
1276 can be examined via **gnt-job info**.
1281 **grow-disk** [--no-wait-for-sync] [--submit] {*instance*} {*disk*}
1284 Grows an instance's disk. This is only possible for instances having a
1285 plain or drbd disk template.
1287 Note that this command only change the block device size; it will not
1288 grow the actual filesystems, partitions, etc. that live on that
1289 disk. Usually, you will need to:
1291 #. use **gnt-instance grow-disk**
1293 #. reboot the instance (later, at a convenient time)
1295 #. use a filesystem resizer, such as ext2online(8) or
1296 xfs\_growfs(8) to resize the filesystem, or use fdisk(8) to change
1297 the partition table on the disk
1299 The *disk* argument is the index of the instance disk to grow. The
1300 *amount* argument is given either as a number (and it represents the
1301 amount to increase the disk with in mebibytes) or can be given similar
1302 to the arguments in the create instance operation, with a suffix
1305 Note that the disk grow operation might complete on one node but fail
1306 on the other; this will leave the instance with different-sized LVs on
1307 the two nodes, but this will not create problems (except for unused
1310 If you do not want gnt-instance to wait for the new disk region to be
1311 synced, use the ``--no-wait-for-sync`` option.
1313 The ``--submit`` option is used to send the job to the master daemon
1314 but not wait for its completion. The job ID will be shown so that it
1315 can be examined via **gnt-job info**.
1317 Example (increase the first disk for instance1 by 16GiB)::
1319 # gnt-instance grow-disk instance1.example.com 0 16g
1322 Also note that disk shrinking is not supported; use **gnt-backup
1323 export** and then **gnt-backup import** to reduce the disk size of an
1329 **recreate-disks** [--submit] [--disks=``indices``] [-n node1:[node2]]
1332 Recreates the disks of the given instance, or only a subset of the
1333 disks (if the option ``disks`` is passed, which must be a
1334 comma-separated list of disk indices, starting from zero).
1336 Note that this functionality should only be used for missing disks; if
1337 any of the given disks already exists, the operation will fail. While
1338 this is suboptimal, recreate-disks should hopefully not be needed in
1339 normal operation and as such the impact of this is low.
1341 Optionally the instance's disks can be recreated on different
1342 nodes. This can be useful if, for example, the original nodes of the
1343 instance have gone down (and are marked offline), so we can't recreate
1344 on the same nodes. To do this, pass the new node(s) via ``-n`` option,
1345 with a syntax similar to the **add** command. The number of nodes
1346 passed must equal the number of nodes that the instance currently
1347 has. Note that changing nodes is only allowed for 'all disk'
1348 replacement (when ``--disks`` is not passed).
1350 The ``--submit`` option is used to send the job to the master daemon
1351 but not wait for its completion. The job ID will be shown so that it
1352 can be examined via **gnt-job info**.
1360 **failover** [-f] [--ignore-consistency] [--shutdown-timeout=*N*]
1361 [--submit] {*instance*}
1363 Failover will stop the instance (if running), change its primary node,
1364 and if it was originally running it will start it again (on the new
1365 primary). This only works for instances with drbd template (in which
1366 case you can only fail to the secondary node) and for externally
1367 mirrored templates (shared storage) (which can change to any other
1370 Normally the failover will check the consistency of the disks before
1371 failing over the instance. If you are trying to migrate instances off
1372 a dead node, this will fail. Use the ``--ignore-consistency`` option
1373 for this purpose. Note that this option can be dangerous as errors in
1374 shutting down the instance will be ignored, resulting in possibly
1375 having the instance running on two machines in parallel (on
1376 disconnected DRBD drives).
1378 The ``--shutdown-timeout`` is used to specify how much time to wait
1379 before forcing the shutdown (xm destroy in xen, killing the kvm
1380 process, for kvm). By default two minutes are given to each instance
1383 The ``--submit`` option is used to send the job to the master daemon
1384 but not wait for its completion. The job ID will be shown so that it
1385 can be examined via **gnt-job info**.
1389 # gnt-instance failover instance1.example.com
1395 **migrate** [-f] {--cleanup} {*instance*}
1397 **migrate** [-f] [--allow-failover] [--non-live]
1398 [--migration-mode=live\|non-live] {*instance*}
1400 Migrate will move the instance to its secondary node without
1401 shutdown. It only works for instances having the drbd8 disk template
1404 The migration command needs a perfectly healthy instance, as we rely
1405 on the dual-master capability of drbd8 and the disks of the instance
1406 are not allowed to be degraded.
1408 The ``--non-live`` and ``--migration-mode=non-live`` options will
1409 switch (for the hypervisors that support it) between a "fully live"
1410 (i.e. the interruption is as minimal as possible) migration and one in
1411 which the instance is frozen, its state saved and transported to the
1412 remote node, and then resumed there. This all depends on the
1413 hypervisor support for two different methods. In any case, it is not
1414 an error to pass this parameter (it will just be ignored if the
1415 hypervisor doesn't support it). The option ``--migration-mode=live``
1416 option will request a fully-live migration. The default, when neither
1417 option is passed, depends on the hypervisor parameters (and can be
1418 viewed with the **gnt-cluster info** command).
1420 If the ``--cleanup`` option is passed, the operation changes from
1421 migration to attempting recovery from a failed previous migration. In
1422 this mode, Ganeti checks if the instance runs on the correct node (and
1423 updates its configuration if not) and ensures the instances's disks
1424 are configured correctly. In this mode, the ``--non-live`` option is
1427 The option ``-f`` will skip the prompting for confirmation.
1429 If ``--allow-failover`` is specified it tries to fallback to failover if
1430 it already can determine that a migration wont work (i.e. if the
1431 instance is shutdown). Please note that the fallback will not happen
1432 during execution. If a migration fails during execution it still fails.
1434 Example (and expected output)::
1436 # gnt-instance migrate instance1
1437 Migrate will happen to the instance instance1. Note that migration is
1438 **experimental** in this version. This might impact the instance if
1439 anything goes wrong. Continue?
1441 * checking disk consistency between source and target
1442 * ensuring the target is in secondary mode
1443 * changing disks into dual-master mode
1444 - INFO: Waiting for instance instance1 to sync disks.
1445 - INFO: Instance instance1's disks are in sync.
1446 * migrating instance to node2.example.com
1447 * changing the instance's disks on source node to secondary
1448 - INFO: Waiting for instance instance1 to sync disks.
1449 - INFO: Instance instance1's disks are in sync.
1450 * changing the instance's disks to single-master
1457 **move** [-f] [--ignore-consistency]
1458 [-n *node*] [--shutdown-timeout=*N*] [--submit]
1461 Move will move the instance to an arbitrary node in the cluster. This
1462 works only for instances having a plain or file disk template.
1464 Note that since this operation is done via data copy, it will take a
1465 long time for big disks (similar to replace-disks for a drbd
1468 The ``--shutdown-timeout`` is used to specify how much time to wait
1469 before forcing the shutdown (e.g. ``xm destroy`` in XEN, killing the
1470 kvm process for KVM, etc.). By default two minutes are given to each
1473 The ``--ignore-consistency`` option will make Ganeti ignore any errors
1474 in trying to shutdown the instance on its node; useful if the
1475 hypervisor is broken and you want to recuperate the data.
1477 The ``--submit`` option is used to send the job to the master daemon
1478 but not wait for its completion. The job ID will be shown so that it
1479 can be examined via **gnt-job info**.
1483 # gnt-instance move -n node3.example.com instance1.example.com
1489 **change-group** [--iallocator *NAME*] [--to *GROUP*...] {*instance*}
1491 This command moves an instance to another node group. The move is
1492 calculated by an iallocator, either given on the command line or as a
1495 If no specific destination groups are specified using ``--to``, all
1496 groups except the one containing the instance are considered.
1500 # gnt-instance change-group -I hail --to rack2 inst1.example.com
1509 **add-tags** [--from *file*] {*instancename*} {*tag*...}
1511 Add tags to the given instance. If any of the tags contains invalid
1512 characters, the entire operation will abort.
1514 If the ``--from`` option is given, the list of tags will be extended
1515 with the contents of that file (each line becomes a tag). In this
1516 case, there is not need to pass tags on the command line (if you do,
1517 both sources will be used). A file name of ``-`` will be interpreted
1523 **list-tags** {*instancename*}
1525 List the tags of the given instance.
1530 **remove-tags** [--from *file*] {*instancename*} {*tag*...}
1532 Remove tags from the given instance. If any of the tags are not
1533 existing on the node, the entire operation will abort.
1535 If the ``--from`` option is given, the list of tags to be removed will
1536 be extended with the contents of that file (each line becomes a tag).
1537 In this case, there is not need to pass tags on the command line (if
1538 you do, tags from both sources will be removed). A file name of ``-``
1539 will be interpreted as stdin.
1541 .. vim: set textwidth=72 :