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 {diskless | file \| plain \| drbd}}
31 | {--disk=*N*: {size=*VAL* \| adopt=*LV*}[,vg=*VG*][,mode=*ro\|rw*]
33 | [--no-ip-check] [--no-name-check] [--no-start] [--no-install]
34 | [--net=*N* [:options...] \| --no-nics]
36 | [-H *HYPERVISOR* [: option=*value*... ]]
37 | [-O, --os-parameters *param*=*value*... ]
38 | [--file-storage-dir *dir\_path*] [--file-driver {loop \| blktap}]
39 | {-n *node[:secondary-node]* \| --iallocator *name*}
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 LVM volume group can also be specified.
53 The size is interpreted (when no unit is given) in mebibytes. You can
54 also use one of the suffixes *m*, *g* or *t* to specify the exact the
55 units used; these suffixes map to mebibytes, gibibytes and tebibytes.
57 When using the ``adopt`` key in the disk definition, Ganeti will
58 reuse those volumes (instead of creating new ones) as the
59 instance's disks. Ganeti will rename these volumes to the standard
60 format, and (without installing the OS) will use them as-is for the
61 instance. This allows migrating instances from non-managed mode
62 (e.q. plain KVM with LVM) to being managed via Ganeti. Note that
63 this works only for the \`plain' disk template (see below for
66 Alternatively, a single-disk instance can be created via the ``-s``
67 option which takes a single argument, the size of the disk. This is
68 similar to the Ganeti 1.2 version (but will only create one disk).
70 The minimum disk specification is therefore ``--disk 0:size=20G`` (or
71 ``-s 20G`` when using the ``-s`` option), and a three-disk instance
72 can be specified as ``--disk 0:size=20G --disk 1:size=4G --disk
75 The ``--no-ip-check`` skips the checks that are done to see if the
76 instance's IP is not already alive (i.e. reachable from the master
79 The ``--no-name-check`` skips the check for the instance name via
80 the resolver (e.g. in DNS or /etc/hosts, depending on your setup).
81 Since the name check is used to compute the IP address, if you pass
82 this option you must also pass the ``--no-ip-check`` option.
84 If you don't wat the instance to automatically start after
85 creation, this is possible via the ``--no-start`` option. This will
86 leave the instance down until a subsequent **gnt-instance start**
89 The NICs of the instances can be specified via the ``--net``
90 option. By default, one NIC is created for the instance, with a
91 random MAC, and set up according the the cluster level nic
92 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 the
111 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.
116 Alternatively, if no network is desired for the instance, you can
117 prevent the default of one NIC with the ``--no-nics`` option.
119 The ``-o`` options specifies the operating system to be installed.
120 The available operating systems can be listed with **gnt-os list**.
121 Passing ``--no-install`` will however skip the OS installation,
122 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`` option specifies the backend parameters for the
128 instance. If no such parameters are specified, the values are
129 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`` option specified the hypervisor to use for the instance
145 (must be one of the enabled hypervisors on the cluster) and
146 optionally custom parameters for this instance. If not other
147 options are used (i.e. the invocation is just -H *NAME*) the
148 instance will inherit the cluster options. The defaults below show
149 the 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:
177 The default is not to set an HVM boot order which is interpreted as
180 For KVM the boot order is either "cdrom", "disk" or "network".
181 Please note that older versions of KVM couldn't netboot from virtio
182 interfaces. This has been fixed in more recent versions and is
183 confirmed to work at least with qemu-kvm 0.11.1.
186 Valid for the Xen HVM and PVM hypervisors.
188 Relevant to nonpvops guest kernels, in which the disk device names are
189 given by the host. Allows to specify 'xvd', which helps run Red Hat based
190 installers, driven by anaconda.
193 Valid for the Xen HVM and KVM hypervisors.
195 The path to a CDROM image to attach to the instance.
198 Valid for the Xen HVM and KVM hypervisors.
200 This parameter determines the way the network cards are presented
201 to the instance. The possible options are:
205 rtl8139 (default for Xen HVM) (HVM & KVM)
206 ne2k\_isa (HVM & KVM)
207 ne2k\_pci (HVM & KVM)
213 paravirtual (default for KVM) (HVM & KVM)
217 Valid for the Xen HVM and KVM hypervisors.
219 This parameter determines the way the disks are presented to the
220 instance. The possible options are:
224 ioemu (default for HVM & KVM) (HVM & KVM)
233 Valid for the Xen HVM and KVM hypervisors.
235 Specifies the address that the VNC listener for this instance
236 should bind to. Valid values are IPv4 addresses. Use the address
237 0.0.0.0 to bind to all available interfaces (this is the default)
238 or specify the address of one of the interfaces on the node to
239 restrict listening to that interface.
242 Valid for the KVM hypervisor.
244 A boolean option that controls whether the VNC connection is
248 Valid for the KVM hypervisor.
250 If ``vnc_tls`` is enabled, this options specifies the path to the
251 x509 certificate to use.
254 Valid for the KVM hypervisor.
257 Valid for the Xen HVM and KVM hypervisors.
259 A boolean option that specifies if the hypervisor should enable
260 ACPI support for this instance. By default, ACPI is disabled.
263 Valid for the Xen HVM and KVM hypervisors.
265 A boolean option that specifies if the hypervisor should enabled
266 PAE support for this instance. The default is false, disabling PAE
270 Valid for the Xen HVM and KVM hypervisors.
272 A boolean option that specifies if the instance should be started
273 with its clock set to the localtime of the machine (when true) or
274 to the UTC (When false). The default is false, which is useful for
275 Linux/Unix machines; for Windows OSes, it is recommended to enable
279 Valid for the Xen PVM and KVM hypervisors.
281 This option specifies the path (on the node) to the kernel to boot
282 the instance with. Xen PVM instances always require this, while for
283 KVM if this option is empty, it will cause the machine to load the
284 kernel from its disks.
287 Valid for the Xen PVM and KVM hypervisors.
289 This options specifies extra arguments to the kernel that will be
290 loaded. device. This is always used for Xen PVM, while for KVM it
291 is only used if the ``kernel_path`` option is also specified.
293 The default setting for this value is simply ``"ro"``, which mounts
294 the root disk (initially) in read-only one. For example, setting
295 this to single will cause the instance to start in single-user
299 Valid for the Xen PVM and KVM hypervisors.
301 This option specifies the path (on the node) to the initrd to boot
302 the instance with. Xen PVM instances can use this always, while for
303 KVM if this option is only used if the ``kernel_path`` option is
304 also specified. You can pass here either an absolute filename (the
305 path to the initrd) if you want to use an initrd, or use the format
306 no\_initrd\_path for no initrd.
309 Valid for the Xen PVM and KVM hypervisors.
311 This options specifies the name of the root device. This is always
312 needed for Xen PVM, while for KVM it is only used if the
313 ``kernel_path`` option is also specified.
316 Valid for the KVM hypervisor.
318 This boolean option specifies whether to emulate a serial console
322 Valid for the KVM hypervisor.
324 The disk cache mode. It can be either default to not pass any cache
325 option to KVM, or one of the KVM cache modes: none (for direct
326 I/O), writethrough (to use the host cache but report completion to
327 the guest only when the host has committed the changes to disk) or
328 writeback (to use the host cache and report completion as soon as
329 the data is in the host cache). Note that there are special
330 considerations for the cache mode depending on version of KVM used
331 and disk type (always raw file under Ganeti), please refer to the
332 KVM documentation for more details.
335 Valid for the KVM hypervisor.
337 The security model for kvm. Currently one of "none", "user" or
338 "pool". Under "none", the default, nothing is done and instances
339 are run as the Ganeti daemon user (normally root).
341 Under "user" kvm will drop privileges and become the user specified
342 by the security\_domain parameter.
344 Under "pool" a global cluster pool of users will be used, making
345 sure no two instances share the same user on the same node. (this
346 mode is not implemented yet)
349 Valid for the KVM hypervisor.
351 Under security model "user" the username to run the instance under.
352 It must be a valid username existing on the host.
354 Cannot be set under security model "none" or "pool".
357 Valid for the KVM hypervisor.
359 If "enabled" the -enable-kvm flag is passed to kvm. If "disabled"
360 -disable-kvm is passed. If unset no flag is passed, and the default
361 running mode for your kvm binary will be used.
364 Valid for the KVM hypervisor.
366 This option passes the -mem-path argument to kvm with the path (on
367 the node) to the mount point of the hugetlbfs file system, along
368 with the -mem-prealloc argument too.
371 Valid for the KVM hypervisor.
373 This boolean option determines wether to run the KVM instance in a
376 If it is set to ``true``, an empty directory is created before
377 starting the instance and its path is passed via the -chroot flag
378 to kvm. The directory is removed when the instance is stopped.
380 It is set to ``false`` by default.
383 Valid for the KVM hypervisor.
385 The maximum amount of time (in ms) a KVM instance is allowed to be
386 frozen during a live migration, in order to copy dirty memory
387 pages. Default value is 30ms, but you may need to increase this
388 value for busy instances.
390 This option is only effective with kvm versions >= 87 and qemu-kvm
394 Valid for the LXC hypervisor.
396 The processes belonging to the given instance are only scheduled on
399 The parameter format is a comma-separated list of CPU IDs or CPU ID
400 ranges. The ranges are defined by a lower and higher boundary,
401 separated by a dash. The boundaries are inclusive.
404 Valid for the KVM hypervisor.
406 This option specifies the usb mouse type to be used. It can be
407 "mouse" or "tablet". When using VNC it's recommended to set it to
411 The ``-O`` (``--os-parameters``) option allows customisation of the OS
412 parameters. The actual parameter names and values depends on the OS
413 being used, but the syntax is the same key=value. For example, setting
414 a hypothetical ``dhcp`` parameter to yes can be achieved by::
416 gnt-instance add -O dhcp=yes ...
419 The ``--iallocator`` option specifies the instance allocator plugin
420 to use. If you pass in this option the allocator will select nodes
421 for this instance automatically, so you don't need to pass them
422 with the ``-n`` option. For more information please refer to the
423 instance allocator documentation.
425 The ``-t`` options specifies the disk layout type for the instance.
426 The available choices are:
431 This creates an instance with no disks. Its useful for testing only
432 (or other special cases).
435 Disk devices will be regular files.
438 Disk devices will be logical volumes.
441 Disk devices will be drbd (version 8.x) on top of lvm volumes.
444 The optional second value of the ``--node`` is used for the drbd
445 template type and specifies the remote node.
447 If you do not want gnt-instance to wait for the disk mirror to be
448 synced, use the ``--no-wait-for-sync`` option.
450 The ``--file-storage-dir`` specifies the relative path under the
451 cluster-wide file storage directory to store file-based disks. It is
452 useful for having different subdirectories for different
453 instances. The full path of the directory where the disk files are
454 stored will consist of cluster-wide file storage directory + optional
455 subdirectory + instance name. Example:
456 ``@RPL_FILE_STORAGE_DIR@``*/mysubdir/instance1.example.com*. This
457 option is only relevant for instances using the file storage backend.
459 The ``--file-driver`` specifies the driver to use for file-based
460 disks. Note that currently these drivers work with the xen
461 hypervisor only. This option is only relevant for instances using
462 the file storage backend. The available choices are:
467 Kernel loopback driver. This driver uses loopback devices to access
468 the filesystem within the file. However, running I/O intensive
469 applications in your instance using the loop driver might result in
470 slowdowns. Furthermore, if you use the loopback driver consider
471 increasing the maximum amount of loopback devices (on most systems
472 it's 8) using the max\_loop param.
475 The blktap driver (for Xen hypervisors). In order to be able to use
476 the blktap driver you should check if the 'blktapctrl' user space
477 disk agent is running (usually automatically started via xend).
478 This user-level disk I/O interface has the advantage of better
479 performance. Especially if you use a network file system (e.g. NFS)
480 to store your instances this is the recommended choice.
483 The ``--submit`` option is used to send the job to the master
484 daemon but not wait for its completion. The job ID will be shown so
485 that it can be examined via **gnt-job info**.
489 # gnt-instance add -t file --disk 0:size=30g -B memory=512 -o debian-etch \
490 -n node1.example.com --file-storage-dir=mysubdir instance1.example.com
491 # gnt-instance add -t plain --disk 0:size=30g -B memory=512 -o debian-etch \
492 -n node1.example.com instance1.example.com
493 # gnt-instance add -t plain --disk 0:size=30g --disk 1:size=100g,vg=san \
494 -B memory=512 -o debian-etch -n node1.example.com instance1.example.com
495 # gnt-instance add -t drbd --disk 0:size=30g -B memory=512 -o debian-etch \
496 -n node1.example.com:node2.example.com instance2.example.com
502 **batch-create** {instances\_file.json}
504 This command (similar to the Ganeti 1.2 **batcher** tool) submits
505 multiple instance creation jobs based on a definition file. The
506 instance configurations do not encompass all the possible options
507 for the **add** command, but only a subset.
509 The instance file should be a valid-formed JSON file, containing a
510 dictionary with instance name and instance parameters. The accepted
516 The size of the disks of the instance.
519 The disk template to use for the instance, the same as in the
523 A dictionary of backend parameters.
526 A dictionary with a single key (the hypervisor name), and as value
527 the hypervisor options. If not passed, the default hypervisor and
528 hypervisor options will be inherited.
531 Specifications for the one NIC that will be created for the
532 instance. 'bridge' is also accepted as a backwards compatibile
536 List of nics that will be created for the instance. Each entry
537 should be a dict, with mac, ip, mode and link as possible keys.
538 Please don't provide the "mac, ip, mode, link" parent keys if you
539 use this method for specifying nics.
541 primary\_node, secondary\_node
542 The primary and optionally the secondary node to use for the
543 instance (in case an iallocator script is not used).
546 Instead of specifying the nodes, an iallocator script can be used
547 to automatically compute them.
550 whether to start the instance
553 Skip the check for already-in-use instance; see the description in
554 the **add** command for details.
557 Skip the name check for instances; see the description in the
558 **add** command for details.
560 file\_storage\_dir, file\_driver
561 Configuration for the file disk type, see the **add** command for
565 A simple definition for one instance can be (with most of the
566 parameters taken from the cluster defaults)::
572 "disk_size": ["25G"],
578 "disk_size": ["25G"],
579 "iallocator": "dumb",
580 "hypervisor": "xen-hvm",
581 "hvparams": {"acpi": true},
582 "backend": {"memory": 512}
586 The command will display the job id for each submitted instance, as
589 # gnt-instance batch-create instances.json
596 **remove** [--ignore-failures] [--shutdown-timeout=*N*] [--submit]
599 Remove an instance. This will remove all data from the instance and
600 there is *no way back*. If you are not sure if you use an instance
601 again, use **shutdown** first and leave it in the shutdown state
604 The ``--ignore-failures`` option will cause the removal to proceed
605 even in the presence of errors during the removal of the instance
606 (e.g. during the shutdown or the disk removal). If this option is
607 not given, the command will stop at the first error.
609 The ``--shutdown-timeout`` is used to specify how much time to wait
610 before forcing the shutdown (e.g. ``xm destroy`` in Xen, killing the
611 kvm process for KVM, etc.). By default two minutes are given to each
614 The ``--submit`` option is used to send the job to the master
615 daemon but not wait for its completion. The job ID will be shown so
616 that it can be examined via **gnt-job info**.
620 # gnt-instance remove instance1.example.com
627 | [--no-headers] [--separator=*SEPARATOR*] [--units=*UNITS*]
628 | [-o *[+]FIELD,...*] [instance...]
630 Shows the currently configured instances with memory usage, disk
631 usage, the node they are running on, and their run status.
633 The ``--no-headers`` option will skip the initial header line. The
634 ``--separator`` option takes an argument which denotes what will be
635 used between the output fields. Both these options are to help
638 The units used to display the numeric values in the output varies,
639 depending on the options given. By default, the values will be
640 formatted in the most appropriate unit. If the ``--separator``
641 option is given, then the values are shown in mebibytes to allow
642 parsing by scripts. In both cases, the ``--units`` option can be
643 used to enforce a given output unit.
645 The ``-o`` option takes a comma-separated list of output fields.
646 The available fields and their meaning are:
654 the OS of the instance
657 the primary node of the instance
660 comma-separated list of secondary nodes for the instance; usually
661 this will be just one node
664 the desired state of the instance (either "yes" or "no" denoting
665 the instance should run or not)
668 the disk template of the instance
671 the actual state of the instance; can be one of the values
672 "running", "stopped", "(node down)"
675 combined form of ``admin_state`` and ``oper_stat``; this can be one of:
676 ``ERROR_nodedown`` if the node of the instance is down, ``ERROR_down`` if
677 the instance should run but is down, ``ERROR_up`` if the instance should be
678 stopped but is actually running, ``ERROR_wrongnode`` if the instance is
679 running but not on the primary, ``ADMIN_down`` if the instance has been
680 stopped (and is stopped) and ``running`` if the instance is set to be
681 running (and is running)
684 the actual memory usage of the instance as seen by the hypervisor
687 the actual number of VCPUs the instance is using as seen by the
691 the ip address Ganeti recognizes as associated with the first
695 the first instance interface MAC address
698 the mode of the first instance NIC (routed or bridged)
701 the link of the first instance NIC
704 the size of the instance's first disk
707 the size of the instance's second disk, if any
710 the number of VCPUs allocated to the instance
713 comma-separated list of the instances's tags
716 the so called 'serial number' of the instance; this is a numeric
717 field that is incremented each time the instance is modified, and
718 it can be used to track modifications
721 the creation time of the instance; note that this field contains
722 spaces and as such it's harder to parse
724 if this attribute is not present (e.g. when upgrading from older
725 versions), then "N/A" will be shown instead
728 the last modification time of the instance; note that this field
729 contains spaces and as such it's harder to parse
731 if this attribute is not present (e.g. when upgrading from older
732 versions), then "N/A" will be shown instead
735 Show the UUID of the instance (generated automatically by Ganeti)
738 If the instance has a network port assigned to it (e.g. for VNC
739 connections), this will be shown, otherwise - will be displayed.
742 A text format of the entire beparams for the instance. It's more
743 useful to select individual fields from this dictionary, see
747 The number of instance disks.
750 The size of the instance's Nth disk. This is a more generic form of
751 the sda\_size and sdb\_size fields.
754 A comma-separated list of the disk sizes for this instance.
757 The total disk space used by this instance on each of its nodes.
758 This is not the instance-visible disk size, but the actual disk
759 "cost" of the instance.
762 The MAC of the Nth instance NIC.
765 The IP address of the Nth instance NIC.
768 The mode of the Nth instance NIC
771 The link of the Nth instance NIC
774 A comma-separated list of all the MACs of the instance's NICs.
777 A comma-separated list of all the IP addresses of the instance's
781 A comma-separated list of all the modes of the instance's NICs.
784 A comma-separated list of all the link parameters of the instance's
788 The number of instance nics.
791 The value of the hypervisor parameter called *NAME*. For details of
792 what hypervisor parameters exist and their meaning, see the **add**
796 The configured memory for the instance.
799 The configured number of VCPUs for the instance.
802 Whether the instance is considered in N+1 checks.
805 If the value of the option starts with the character ``+``, the new
806 field(s) will be added to the default list. This allows to quickly
807 see the default list plus a few other fields, instead of retyping
808 the entire list of fields.
810 There is a subtle grouping about the available output fields: all
811 fields except for ``oper_state``, ``oper_ram``, ``oper_vcpus`` and
812 ``status`` are configuration value and not run-time values. So if
813 you don't select any of the these fields, the query will be
814 satisfied instantly from the cluster configuration, without having
815 to ask the remote nodes for the data. This can be helpful for big
816 clusters when you only want some data and it makes sense to specify
817 a reduced set of output fields.
819 The default output field list is: name, os, pnode, admin\_state,
820 oper\_state, oper\_ram.
826 **list-fields** [field...]
828 Lists available fields for instances.
834 **info** [-s \| --static] [--roman] {--all \| *instance*}
836 Show detailed information about the given instance(s). This is
837 different from **list** as it shows detailed data about the
838 instance's disks (especially useful for the drbd disk template).
840 If the option ``-s`` is used, only information available in the
841 configuration file is returned, without querying nodes, making the
844 Use the ``--all`` to get info about all instances, rather than
845 explicitly passing the ones you're interested in.
847 The ``--roman`` option can be used to cause envy among people who
848 like ancient cultures, but are stuck with non-latin-friendly
849 cluster virtualization technologies.
855 | [-H *HYPERVISOR\_PARAMETERS*]
856 | [-B *BACKEND\_PARAMETERS*]
857 | [--net add*[:options]* \| --net remove \| --net *N:options*]
858 | [--disk add:size=*SIZE*[,vg=*VG*] \| --disk remove \|
859 | --disk *N*:mode=*MODE*]
860 | [-t plain | -t drbd -n *new_secondary*]
861 | [--os-type=*OS* [--force-variant]]
862 | [-O, --os-parameters *param*=*value*... ]
866 Modifies the memory size, number of vcpus, ip address, MAC address
867 and/or nic parameters for an instance. It can also add and remove
868 disks and NICs to/from the instance. Note that you need to give at
869 least one of the arguments, otherwise the command complains.
871 The ``-H``, ``-B`` and ``-O`` options specifies hypervisor, backend
872 and OS parameter options in the form of name=value[,...]. For details
873 which options can be specified, see the **add** command.
875 The ``-t`` option will change the disk template of the instance.
876 Currently only conversions between the plain and drbd disk templates
877 are supported, and the instance must be stopped before attempting the
878 conversion. When changing from the plain to the drbd disk template, a
879 new secondary node must be specified via the ``-n`` option.
881 The ``--disk add:size=``*SIZE* option adds a disk to the instance. The
882 optional ``vg=``*VG* option specifies LVM volume group other than default
883 vg to create disk on. The ``--disk remove`` option will remove the last
884 disk of the instance. The ``--disk`` *N*``:mode=``*MODE* option will change
885 the mode of the Nth disk of the instance between read-only (``ro``) and
888 The ``--net add:``*options* option will add a new NIC to the
889 instance. The available options are the same as in the **add** command
890 (mac, ip, link, mode). The ``--net remove`` will remove the last NIC
891 of the instance, while the ``--net`` *N*:*options* option will
892 change the parameters of the Nth instance NIC.
894 The option ``--os-type`` will change the OS name for the instance
895 (without reinstallation). In case an OS variant is specified that
896 is not found, then by default the modification is refused, unless
897 ``--force-variant`` is passed. An invalid OS will also be refused,
898 unless the ``--force`` option is given.
900 The ``--submit`` option is used to send the job to the master
901 daemon but not wait for its completion. The job ID will be shown so
902 that it can be examined via **gnt-job info**.
904 All the changes take effect at the next restart. If the instance is
905 running, there is no effect on the instance.
910 | **reinstall** [-o *os-type*] [--select-os] [-f *force*]
912 | [--instance \| --node \| --primary \| --secondary \| --all]
913 | [-O *OS\_PARAMETERS*] [--submit] {*instance*...}
915 Reinstalls the operating system on the given instance(s). The
916 instance(s) must be stopped when running this command. If the
917 ``--os-type`` is specified, the operating system is changed.
919 The ``--select-os`` option switches to an interactive OS reinstall.
920 The user is prompted to select the OS template from the list of
921 available OS templates. OS parameters can be overridden using ``-O``
922 (more documentation for this option under the **add** command).
924 Since this is a potentially dangerous command, the user will be
925 required to confirm this action, unless the ``-f`` flag is passed.
926 When multiple instances are selected (either by passing multiple
927 arguments or by using the ``--node``, ``--primary``,
928 ``--secondary`` or ``--all`` options), the user must pass the
929 ``--force-multiple`` options to skip the interactive confirmation.
931 The ``--submit`` option is used to send the job to the master
932 daemon but not wait for its completion. The job ID will be shown so
933 that it can be examined via **gnt-job info**.
938 | **rename** [--no-ip-check] [--no-name-check] [--submit]
939 | {*instance*} {*new\_name*}
941 Renames the given instance. The instance must be stopped when
942 running this command. The requirements for the new name are the
943 same as for adding an instance: the new name must be resolvable and
944 the IP it resolves to must not be reachable (in order to prevent
945 duplicate IPs the next time the instance is started). The IP test
946 can be skipped if the ``--no-ip-check`` option is passed.
948 The ``--no-name-check`` skips the check for the new instance name
949 via the resolver (e.g. in DNS or /etc/hosts, depending on your
950 setup). Since the name check is used to compute the IP address, if
951 you pass this option you must also pass the ``--no-ip-check``
954 The ``--submit`` option is used to send the job to the master
955 daemon but not wait for its completion. The job ID will be shown so
956 that it can be examined via **gnt-job info**.
958 Starting/stopping/connecting to console
959 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
965 | [--force] [--ignore-offline]
967 | [--instance \| --node \| --primary \| --secondary \| --all \|
968 | --tags \| --node-tags \| --pri-node-tags \| --sec-node-tags]
969 | [-H ``key=value...``] [-B ``key=value...``]
973 Starts one or more instances, depending on the following options.
974 The four available modes are:
978 will start the instances given as arguments (at least one argument
979 required); this is the default selection
982 will start the instances who have the given node as either primary
986 will start all instances whose primary node is in the list of nodes
987 passed as arguments (at least one node required)
990 will start all instances whose secondary node is in the list of
991 nodes passed as arguments (at least one node required)
994 will start all instances in the cluster (no arguments accepted)
997 will start all instances in the cluster with the tags given as
1001 will start all instances in the cluster on nodes with the tags
1005 will start all instances in the cluster on primary nodes with the
1006 tags given as arguments
1009 will start all instances in the cluster on secondary nodes with the
1010 tags given as arguments
1013 Note that although you can pass more than one selection option, the
1014 last one wins, so in order to guarantee the desired result, don't
1015 pass more than one such option.
1017 Use ``--force`` to start even if secondary disks are failing.
1018 ``--ignore-offline`` can be used to ignore offline primary nodes
1019 and mark the instance as started even if the primary is not
1022 The ``--force-multiple`` will skip the interactive confirmation in
1023 the case the more than one instance will be affected.
1025 The ``-H`` and ``-B`` options specify temporary hypervisor and
1026 backend parameters that can be used to start an instance with
1027 modified parameters. They can be useful for quick testing without
1028 having to modify an instance back and forth, e.g.::
1030 # gnt-instance start -H root_args="single" instance1
1031 # gnt-instance start -B memory=2048 instance2
1034 The first form will start the instance instance1 in single-user
1035 mode, and the instance instance2 with 2GB of RAM (this time only,
1036 unless that is the actual instance memory size already). Note that
1037 the values override the instance parameters (and not extend them):
1038 an instance with "root\_args=ro" when started with -H
1039 root\_args=single will result in "single", not "ro single".
1040 The ``--submit`` option is used to send the job to the master
1041 daemon but not wait for its completion. The job ID will be shown so
1042 that it can be examined via **gnt-job info**.
1046 # gnt-instance start instance1.example.com
1047 # gnt-instance start --node node1.example.com node2.example.com
1048 # gnt-instance start --all
1056 | [--force-multiple] [--ignore-offline]
1057 | [--instance \| --node \| --primary \| --secondary \| --all \|
1058 | --tags \| --node-tags \| --pri-node-tags \| --sec-node-tags]
1062 Stops one or more instances. If the instance cannot be cleanly
1063 stopped during a hardcoded interval (currently 2 minutes), it will
1064 forcibly stop the instance (equivalent to switching off the power
1065 on a physical machine).
1067 The ``--timeout`` is used to specify how much time to wait before
1068 forcing the shutdown (e.g. ``xm destroy`` in Xen, killing the kvm
1069 process for KVM, etc.). By default two minutes are given to each
1072 The ``--instance``, ``--node``, ``--primary``, ``--secondary``,
1073 ``--all``, ``--tags``, ``--node-tags``, ``--pri-node-tags`` and
1074 ``--sec-node-tags`` options are similar as for the **startup**
1075 command and they influence the actual instances being shutdown.
1077 The ``--submit`` option is used to send the job to the master
1078 daemon but not wait for its completion. The job ID will be shown so
1079 that it can be examined via **gnt-job info**.
1081 ``--ignore-offline`` can be used to ignore offline primary nodes
1082 and force the instance to be marked as stopped. This option should
1083 be used with care as it can lead to an inconsistent cluster state.
1087 # gnt-instance shutdown instance1.example.com
1088 # gnt-instance shutdown --all
1095 | [--type=*REBOOT-TYPE*]
1096 | [--ignore-secondaries]
1097 | [--shutdown-timeout=*N*]
1098 | [--force-multiple]
1099 | [--instance \| --node \| --primary \| --secondary \| --all \|
1100 | --tags \| --node-tags \| --pri-node-tags \| --sec-node-tags]
1104 Reboots one or more instances. The type of reboot depends on the
1105 value of ``--type``. A soft reboot does a hypervisor reboot, a hard
1106 reboot does a instance stop, recreates the hypervisor config for
1107 the instance and starts the instance. A full reboot does the
1108 equivalent of **gnt-instance shutdown && gnt-instance startup**.
1109 The default is hard reboot.
1111 For the hard reboot the option ``--ignore-secondaries`` ignores
1112 errors for the secondary node while re-assembling the instance
1115 The ``--instance``, ``--node``, ``--primary``, ``--secondary``,
1116 ``--all``, ``--tags``, ``--node-tags``, ``--pri-node-tags`` and
1117 ``--sec-node-tags`` options are similar as for the **startup**
1118 command and they influence the actual instances being rebooted.
1120 The ``--shutdown-timeout`` is used to specify how much time to wait
1121 before forcing the shutdown (xm destroy in xen, killing the kvm
1122 process, for kvm). By default two minutes are given to each
1125 The ``--force-multiple`` will skip the interactive confirmation in
1126 the case the more than one instance will be affected.
1130 # gnt-instance reboot instance1.example.com
1131 # gnt-instance reboot --type=full instance1.example.com
1137 **console** [--show-cmd] {*instance*}
1139 Connects to the console of the given instance. If the instance is
1140 not up, an error is returned. Use the ``--show-cmd`` option to
1141 display the command instead of executing it.
1143 For HVM instances, this will attempt to connect to the serial
1144 console of the instance. To connect to the virtualized "physical"
1145 console of a HVM instance, use a VNC client with the connection
1146 info from the **info** command.
1150 # gnt-instance console instance1.example.com
1159 **replace-disks** [--submit] [--early-release] {-p} [--disks *idx*]
1162 **replace-disks** [--submit] [--early-release] {-s} [--disks *idx*]
1165 **replace-disks** [--submit] [--early-release] {--iallocator *name*
1166 \| --new-secondary *NODE*} {*instance*}
1168 **replace-disks** [--submit] [--early-release] {--auto}
1171 This command is a generalized form for replacing disks. It is
1172 currently only valid for the mirrored (DRBD) disk template.
1174 The first form (when passing the ``-p`` option) will replace the
1175 disks on the primary, while the second form (when passing the
1176 ``-s`` option will replace the disks on the secondary node. For
1177 these two cases (as the node doesn't change), it is possible to
1178 only run the replace for a subset of the disks, using the option
1179 ``--disks`` which takes a list of comma-delimited disk indices
1180 (zero-based), e.g. 0,2 to replace only the first and third disks.
1182 The third form (when passing either the ``--iallocator`` or the
1183 ``--new-secondary`` option) is designed to change secondary node of
1184 the instance. Specifying ``--iallocator`` makes the new secondary
1185 be selected automatically by the specified allocator plugin,
1186 otherwise the new secondary node will be the one chosen manually
1187 via the ``--new-secondary`` option.
1189 The fourth form (when using ``--auto``) will automatically
1190 determine which disks of an instance are faulty and replace them
1191 within the same node. The ``--auto`` option works only when an
1192 instance has only faulty disks on either the primary or secondary
1193 node; it doesn't work when both sides have faulty disks.
1195 The ``--submit`` option is used to send the job to the master
1196 daemon but not wait for its completion. The job ID will be shown so
1197 that it can be examined via **gnt-job info**.
1199 The ``--early-release`` changes the code so that the old storage on
1200 secondary node(s) is removed early (before the resync is completed)
1201 and the internal Ganeti locks for the current (and new, if any)
1202 secondary node are also released, thus allowing more parallelism in
1203 the cluster operation. This should be used only when recovering
1204 from a disk failure on the current secondary (thus the old storage
1205 is already broken) or when the storage on the primary node is known
1206 to be fine (thus we won't need the old storage for potential
1209 Note that it is not possible to select an offline or drained node
1215 **activate-disks** [--submit] [--ignore-size] {*instance*}
1217 Activates the block devices of the given instance. If successful,
1218 the command will show the location and name of the block devices::
1220 node1.example.com:disk/0:/dev/drbd0
1221 node1.example.com:disk/1:/dev/drbd1
1224 In this example, *node1.example.com* is the name of the node on
1225 which the devices have been activated. The *disk/0* and *disk/1*
1226 are the Ganeti-names of the instance disks; how they are visible
1227 inside the instance is hypervisor-specific. */dev/drbd0* and
1228 */dev/drbd1* are the actual block devices as visible on the node.
1229 The ``--submit`` option is used to send the job to the master
1230 daemon but not wait for its completion. The job ID will be shown so
1231 that it can be examined via **gnt-job info**.
1233 The ``--ignore-size`` option can be used to activate disks ignoring
1234 the currently configured size in Ganeti. This can be used in cases
1235 where the configuration has gotten out of sync with the real-world
1236 (e.g. after a partially-failed grow-disk operation or due to
1237 rounding in LVM devices). This should not be used in normal cases,
1238 but only when activate-disks fails without it.
1240 Note that it is safe to run this command while the instance is
1246 **deactivate-disks** [-f] [--submit] {*instance*}
1248 De-activates the block devices of the given instance. Note that if
1249 you run this command for an instance with a drbd disk template,
1250 while it is running, it will not be able to shutdown the block
1251 devices on the primary node, but it will shutdown the block devices
1252 on the secondary nodes, thus breaking the replication.
1254 The ``-f``/``--force`` option will skip checks that the instance is
1255 down; in case the hypervisor is confused and we can't talk to it,
1256 normally Ganeti will refuse to deactivate the disks, but with this
1257 option passed it will skip this check and directly try to deactivate
1258 the disks. This can still fail due to the instance actually running or
1261 The ``--submit`` option is used to send the job to the master
1262 daemon but not wait for its completion. The job ID will be shown so
1263 that it can be examined via **gnt-job info**.
1268 **grow-disk** [--no-wait-for-sync] [--submit] {*instance*} {*disk*}
1271 Grows an instance's disk. This is only possible for instances
1272 having a plain or drbd disk template.
1274 Note that this command only change the block device size; it will
1275 not grow the actual filesystems, partitions, etc. that live on that
1276 disk. Usually, you will need to:
1281 #. use **gnt-instance grow-disk**
1283 #. reboot the instance (later, at a convenient time)
1285 #. use a filesystem resizer, such as ext2online(8) or
1286 xfs\_growfs(8) to resize the filesystem, or use fdisk(8) to change
1287 the partition table on the disk
1290 The *disk* argument is the index of the instance disk to grow. The
1291 *amount* argument is given either as a number (and it represents
1292 the amount to increase the disk with in mebibytes) or can be given
1293 similar to the arguments in the create instance operation, with a
1294 suffix denoting the unit.
1296 Note that the disk grow operation might complete on one node but
1297 fail on the other; this will leave the instance with
1298 different-sized LVs on the two nodes, but this will not create
1299 problems (except for unused space).
1301 If you do not want gnt-instance to wait for the new disk region to
1302 be synced, use the ``--no-wait-for-sync`` option.
1304 The ``--submit`` option is used to send the job to the master
1305 daemon but not wait for its completion. The job ID will be shown so
1306 that it can be examined via **gnt-job info**.
1308 Example (increase the first disk for instance1 by 16GiB)::
1310 # gnt-instance grow-disk instance1.example.com 0 16g
1313 Also note that disk shrinking is not supported; use
1314 **gnt-backup export** and then **gnt-backup import** to reduce the
1315 disk size of an instance.
1320 **recreate-disks** [--submit] [--disks=``indices``] {*instance*}
1322 Recreates the disks of the given instance, or only a subset of the
1323 disks (if the option ``disks`` is passed, which must be a
1324 comma-separated list of disk indices, starting from zero).
1326 Note that this functionality should only be used for missing disks;
1327 if any of the given disks already exists, the operation will fail.
1328 While this is suboptimal, recreate-disks should hopefully not be
1329 needed in normal operation and as such the impact of this is low.
1331 The ``--submit`` option is used to send the job to the master
1332 daemon but not wait for its completion. The job ID will be shown so
1333 that it can be examined via **gnt-job info**.
1341 **failover** [-f] [--ignore-consistency] [--shutdown-timeout=*N*]
1342 [--submit] {*instance*}
1344 Failover will fail the instance over its secondary node. This works
1345 only for instances having a drbd disk template.
1347 Normally the failover will check the consistency of the disks
1348 before failing over the instance. If you are trying to migrate
1349 instances off a dead node, this will fail. Use the
1350 ``--ignore-consistency`` option for this purpose. Note that this
1351 option can be dangerous as errors in shutting down the instance
1352 will be ignored, resulting in possibly having the instance running
1353 on two machines in parallel (on disconnected DRBD drives).
1355 The ``--shutdown-timeout`` is used to specify how much time to wait
1356 before forcing the shutdown (xm destroy in xen, killing the kvm
1357 process, for kvm). By default two minutes are given to each
1360 The ``--submit`` option is used to send the job to the master
1361 daemon but not wait for its completion. The job ID will be shown so
1362 that it can be examined via **gnt-job info**.
1366 # gnt-instance failover instance1.example.com
1372 **migrate** [-f] {--cleanup} {*instance*}
1374 **migrate** [-f] [--non-live] [--migration-mode=live\|non-live]
1377 Migrate will move the instance to its secondary node without
1378 shutdown. It only works for instances having the drbd8 disk
1381 The migration command needs a perfectly healthy instance, as we
1382 rely on the dual-master capability of drbd8 and the disks of the
1383 instance are not allowed to be degraded.
1385 The ``--non-live`` and ``--migration-mode=non-live`` options will
1386 switch (for the hypervisors that support it) between a "fully live"
1387 (i.e. the interruption is as minimal as possible) migration and one
1388 in which the instance is frozen, its state saved and transported to
1389 the remote node, and then resumed there. This all depends on the
1390 hypervisor support for two different methods. In any case, it is
1391 not an error to pass this parameter (it will just be ignored if the
1392 hypervisor doesn't support it). The option
1393 ``--migration-mode=live`` option will request a fully-live
1394 migration. The default, when neither option is passed, depends on
1395 the hypervisor parameters (and can be viewed with the
1396 **gnt-cluster info** command).
1398 If the ``--cleanup`` option is passed, the operation changes from
1399 migration to attempting recovery from a failed previous migration.
1400 In this mode, Ganeti checks if the instance runs on the correct
1401 node (and updates its configuration if not) and ensures the
1402 instances's disks are configured correctly. In this mode, the
1403 ``--non-live`` option is ignored.
1405 The option ``-f`` will skip the prompting for confirmation.
1407 Example (and expected output)::
1409 # gnt-instance migrate instance1
1410 Migrate will happen to the instance instance1. Note that migration is
1411 **experimental** in this version. This might impact the instance if
1412 anything goes wrong. Continue?
1414 * checking disk consistency between source and target
1415 * ensuring the target is in secondary mode
1416 * changing disks into dual-master mode
1417 - INFO: Waiting for instance instance1 to sync disks.
1418 - INFO: Instance instance1's disks are in sync.
1419 * migrating instance to node2.example.com
1420 * changing the instance's disks on source node to secondary
1421 - INFO: Waiting for instance instance1 to sync disks.
1422 - INFO: Instance instance1's disks are in sync.
1423 * changing the instance's disks to single-master
1430 **move** [-f] [-n *node*] [--shutdown-timeout=*N*] [--submit]
1433 Move will move the instance to an arbitrary node in the cluster.
1434 This works only for instances having a plain or file disk
1437 Note that since this operation is done via data copy, it will take
1438 a long time for big disks (similar to replace-disks for a drbd
1441 The ``--shutdown-timeout`` is used to specify how much time to wait
1442 before forcing the shutdown (e.g. ``xm destroy`` in XEN, killing the
1443 kvm process for KVM, etc.). By default two minutes are given to each
1446 The ``--submit`` option is used to send the job to the master
1447 daemon but not wait for its completion. The job ID will be shown so
1448 that it can be examined via **gnt-job info**.
1452 # gnt-instance move -n node3.example.com instance1.example.com
1461 **add-tags** [--from *file*] {*instancename*} {*tag*...}
1463 Add tags to the given instance. If any of the tags contains invalid
1464 characters, the entire operation will abort.
1466 If the ``--from`` option is given, the list of tags will be
1467 extended with the contents of that file (each line becomes a tag).
1468 In this case, there is not need to pass tags on the command line
1469 (if you do, both sources will be used). A file name of - will be
1470 interpreted as stdin.
1475 **list-tags** {*instancename*}
1477 List the tags of the given instance.
1482 **remove-tags** [--from *file*] {*instancename*} {*tag*...}
1484 Remove tags from the given instance. If any of the tags are not
1485 existing on the node, the entire operation will abort.
1487 If the ``--from`` option is given, the list of tags to be removed will
1488 be extended with the contents of that file (each line becomes a tag).
1489 In this case, there is not need to pass tags on the command line (if
1490 you do, tags from both sources will be removed). A file name of - will
1491 be interpreted as stdin.