^^^
| **add**
-| {-t {diskless | file \| plain \| drbd}}
-| {--disk=*N*: {size=*VAL* \| adopt=*LV*}[,vg=*VG*][,mode=*ro\|rw*]
-| \| -s *SIZE*}
-| [--no-ip-check] [--no-name-check] [--no-start] [--no-install]
-| [--net=*N* [:options...] \| --no-nics]
-| [-B *BEPARAMS*]
-| [-H *HYPERVISOR* [: option=*value*... ]]
-| [-O, --os-parameters *param*=*value*... ]
-| [--file-storage-dir *dir\_path*] [--file-driver {loop \| blktap}]
-| {-n *node[:secondary-node]* \| --iallocator *name*}
-| {-o *os-type*}
-| [--submit]
+| {-t|\--disk-template {diskless | file \| plain \| drbd \| rbd}}
+| {\--disk=*N*: {size=*VAL* \| adopt=*LV*}[,vg=*VG*][,metavg=*VG*][,mode=*ro\|rw*]
+| \| {-s|\--os-size} *SIZE*}
+| [\--no-ip-check] [\--no-name-check] [\--no-start] [\--no-install]
+| [\--net=*N* [:options...] \| \--no-nics]
+| [{-B|\--backend-parameters} *BEPARAMS*]
+| [{-H|\--hypervisor-parameters} *HYPERVISOR* [: option=*value*... ]]
+| [{-O|\--os-parameters} *param*=*value*... ]
+| [\--file-storage-dir *dir\_path*] [\--file-driver {loop \| blktap}]
+| {{-n|\--node} *node[:secondary-node]* \| {-I|\--iallocator} *name*}
+| {{-o|\--os-type} *os-type*}
+| [\--submit]
+| [\--ignore-ipolicy]
| {*instance*}
Creates a new instance on the specified host. The *instance* argument
instance. The numbering of disks starts at zero, and at least one disk
needs to be passed. For each disk, either the size or the adoption
source needs to be given, and optionally the access mode (read-only or
-the default of read-write) and LVM volume group can also be specified.
-The size is interpreted (when no unit is given) in mebibytes. You can
-also use one of the suffixes *m*, *g* or *t* to specify the exact the
-units used; these suffixes map to mebibytes, gibibytes and tebibytes.
+the default of read-write) and the LVM volume group can also be
+specified (via the ``vg`` key). For DRBD devices, a different VG can
+be specified for the metadata device using the ``metavg`` key. The
+size is interpreted (when no unit is given) in mebibytes. You can also
+use one of the suffixes *m*, *g* or *t* to specify the exact the units
+used; these suffixes map to mebibytes, gibibytes and tebibytes.
When using the ``adopt`` key in the disk definition, Ganeti will
reuse those volumes (instead of creating new ones) as the
instance's disks. Ganeti will rename these volumes to the standard
format, and (without installing the OS) will use them as-is for the
instance. This allows migrating instances from non-managed mode
-(e.q. plain KVM with LVM) to being managed via Ganeti. Note that
+(e.g. plain KVM with LVM) to being managed via Ganeti. Please note that
this works only for the \`plain' disk template (see below for
template details).
Since the name check is used to compute the IP address, if you pass
this option you must also pass the ``--no-ip-check`` option.
-If you don't wat the instance to automatically start after
+If you don't want the instance to automatically start after
creation, this is possible via the ``--no-start`` option. This will
leave the instance down until a subsequent **gnt-instance start**
command.
random MAC, and set up according the the cluster level nic
parameters. Each NIC can take these parameters (all optional):
-
-
mac
either a value or 'generate' to generate a new unique MAC
link
in bridged mode specifies the bridge to attach this NIC to, in
routed mode it's intended to differentiate between different
- routing tables/instance groups (but the meaning is dependent on the
- network script, see gnt-cluster(8) for more details)
+ routing tables/instance groups (but the meaning is dependent on
+ the network script, see gnt-cluster(8) for more details)
Of these "mode" and "link" are nic parameters, and inherit their
-default at cluster level.
-Alternatively, if no network is desired for the instance, you can
-prevent the default of one NIC with the ``--no-nics`` option.
-
-The ``-o`` options specifies the operating system to be installed.
-The available operating systems can be listed with **gnt-os list**.
-Passing ``--no-install`` will however skip the OS installation,
-allowing a manual import if so desired. Note that the
+default at cluster level. Alternatively, if no network is desired for
+the instance, you can prevent the default of one NIC with the
+``--no-nics`` option.
+
+The ``-o (--os-type)`` option specifies the operating system to be
+installed. The available operating systems can be listed with
+**gnt-os list**. Passing ``--no-install`` will however skip the OS
+installation, allowing a manual import if so desired. Note that the
no-installation mode will automatically disable the start-up of the
instance (without an OS, it most likely won't be able to start-up
successfully).
-The ``-B`` option specifies the backend parameters for the
-instance. If no such parameters are specified, the values are
-inherited from the cluster. Possible parameters are:
+The ``-B (--backend-parameters)`` option specifies the backend
+parameters for the instance. If no such parameters are specified, the
+values are inherited from the cluster. Possible parameters are:
+
+maxmem
+ the maximum memory size of the instance; as usual, suffixes can be
+ used to denote the unit, otherwise the value is taken in mebibytes
-memory
- the memory size of the instance; as usual, suffixes can be used to
- denote the unit, otherwise the value is taken in mebibites
+minmem
+ the minimum memory size of the instance; as usual, suffixes can be
+ used to denote the unit, otherwise the value is taken in mebibytes
vcpus
the number of VCPUs to assign to the instance (if this value makes
whether the instance is considered in the N+1 cluster checks
(enough redundancy in the cluster to survive a node failure)
+always\_failover
+ ``True`` or ``False``, whether the instance must be failed over
+ (shut down and rebooted) always or it may be migrated (briefly
+ suspended)
-The ``-H`` option specified the hypervisor to use for the instance
-(must be one of the enabled hypervisors on the cluster) and
-optionally custom parameters for this instance. If not other
-options are used (i.e. the invocation is just -H *NAME*) the
-instance will inherit the cluster options. The defaults below show
-the cluster defaults at cluster creation time.
+Note that before 2.6 Ganeti had a ``memory`` parameter, which was the
+only value of memory an instance could have. With the
+``maxmem``/``minmem`` change Ganeti guarantees that at least the minimum
+memory is always available for an instance, but allows more memory to be
+used (up to the maximum memory) should it be free.
+
+The ``-H (--hypervisor-parameters)`` option specified the hypervisor
+to use for the instance (must be one of the enabled hypervisors on the
+cluster) and optionally custom parameters for this instance. If not
+other options are used (i.e. the invocation is just -H *NAME*) the
+instance will inherit the cluster options. The defaults below show the
+cluster defaults at cluster creation time.
The possible hypervisor options are as follows:
For Xen HVM, The boot order is a string of letters listing the boot
devices, with valid device letters being:
-
-
a
floppy drive
n
network boot (PXE)
+ The default is not to set an HVM boot order, which is interpreted
+ as 'dc'.
- The default is not to set an HVM boot order which is interpreted as
- 'dc'.
-
- For KVM the boot order is either "cdrom", "disk" or "network".
- Please note that older versions of KVM couldn't netboot from virtio
- interfaces. This has been fixed in more recent versions and is
- confirmed to work at least with qemu-kvm 0.11.1.
+ For KVM the boot order is either "floppy", "cdrom", "disk" or
+ "network". Please note that older versions of KVM couldn't netboot
+ from virtio interfaces. This has been fixed in more recent versions
+ and is confirmed to work at least with qemu-kvm 0.11.1. Also note
+ that if you have set the ``kernel_path`` option, that will be used
+ for booting, and this setting will be silently ignored.
blockdev\_prefix
Valid for the Xen HVM and PVM hypervisors.
- Relevant to nonpvops guest kernels, in which the disk device names are
- given by the host. Allows to specify 'xvd', which helps run Red Hat based
- installers, driven by anaconda.
+ Relevant to non-pvops guest kernels, in which the disk device names
+ are given by the host. Allows one to specify 'xvd', which helps run
+ Red Hat based installers, driven by anaconda.
+
+floppy\_image\_path
+ Valid for the KVM hypervisor.
+
+ The path to a floppy disk image to attach to the instance. This
+ is useful to install Windows operating systems on Virt/IO disks
+ because you can specify here the floppy for the drivers at
+ installation time.
cdrom\_image\_path
Valid for the Xen HVM and KVM hypervisors.
The path to a CDROM image to attach to the instance.
+cdrom2\_image\_path
+ Valid for the KVM hypervisor.
+
+ The path to a second CDROM image to attach to the instance.
+ **NOTE**: This image can't be used to boot the system. To do that
+ you have to use the 'cdrom\_image\_path' option.
+
nic\_type
Valid for the Xen HVM and KVM hypervisors.
This parameter determines the way the network cards are presented
to the instance. The possible options are:
-
-
- rtl8139 (default for Xen HVM) (HVM & KVM)
- ne2k\_isa (HVM & KVM)
- ne2k\_pci (HVM & KVM)
- i82551 (KVM)
- i82557b (KVM)
- i82559er (KVM)
- pcnet (KVM)
- e1000 (KVM)
- paravirtual (default for KVM) (HVM & KVM)
-
+ - rtl8139 (default for Xen HVM) (HVM & KVM)
+ - ne2k\_isa (HVM & KVM)
+ - ne2k\_pci (HVM & KVM)
+ - i82551 (KVM)
+ - i82557b (KVM)
+ - i82559er (KVM)
+ - pcnet (KVM)
+ - e1000 (KVM)
+ - paravirtual (default for KVM) (HVM & KVM)
disk\_type
Valid for the Xen HVM and KVM hypervisors.
This parameter determines the way the disks are presented to the
instance. The possible options are:
+ - ioemu [default] (HVM & KVM)
+ - ide (HVM & KVM)
+ - scsi (KVM)
+ - sd (KVM)
+ - mtd (KVM)
+ - pflash (KVM)
+
+cdrom\_disk\_type
+ Valid for the KVM hypervisor.
- ioemu (default for HVM & KVM) (HVM & KVM)
- ide (HVM & KVM)
- scsi (KVM)
- sd (KVM)
- mtd (KVM)
- pflash (KVM)
+ This parameter determines the way the cdroms disks are presented
+ to the instance. The default behavior is to get the same value of
+ the earlier parameter (disk_type). The possible options are:
+
+ - paravirtual
+ - ide
+ - scsi
+ - sd
+ - mtd
+ - pflash
vnc\_bind\_address
vnc\_x509\_verify
Valid for the KVM hypervisor.
+spice\_bind
+ Valid for the KVM hypervisor.
+
+ Specifies the address or interface on which the SPICE server will
+ listen. Valid values are:
+
+ - IPv4 addresses, including 0.0.0.0 and 127.0.0.1
+ - IPv6 addresses, including :: and ::1
+ - names of network interfaces
+
+ If a network interface is specified, the SPICE server will be bound
+ to one of the addresses of that interface.
+
+spice\_ip\_version
+ Valid for the KVM hypervisor.
+
+ Specifies which version of the IP protocol should be used by the
+ SPICE server.
+
+ It is mainly intended to be used for specifying what kind of IP
+ addresses should be used if a network interface with both IPv4 and
+ IPv6 addresses is specified via the ``spice_bind`` parameter. In
+ this case, if the ``spice_ip_version`` parameter is not used, the
+ default IP version of the cluster will be used.
+
+spice\_password\_file
+ Valid for the KVM hypervisor.
+
+ Specifies a file containing the password that must be used when
+ connecting via the SPICE protocol. If the option is not specified,
+ passwordless connections are allowed.
+
+spice\_image\_compression
+ Valid for the KVM hypervisor.
+
+ Configures the SPICE lossless image compression. Valid values are:
+
+ - auto_glz
+ - auto_lz
+ - quic
+ - glz
+ - lz
+ - off
+
+spice\_jpeg\_wan\_compression
+ Valid for the KVM hypervisor.
+
+ Configures how SPICE should use the jpeg algorithm for lossy image
+ compression on slow links. Valid values are:
+
+ - auto
+ - never
+ - always
+
+spice\_zlib\_glz\_wan\_compression
+ Valid for the KVM hypervisor.
+
+ Configures how SPICE should use the zlib-glz algorithm for lossy image
+ compression on slow links. Valid values are:
+
+ - auto
+ - never
+ - always
+
+spice\_streaming\_video
+ Valid for the KVM hypervisor.
+
+ Configures how SPICE should detect video streams. Valid values are:
+
+ - off
+ - all
+ - filter
+
+spice\_playback\_compression
+ Valid for the KVM hypervisor.
+
+ Configures whether SPICE should compress audio streams or not.
+
+spice\_use\_tls
+ Valid for the KVM hypervisor.
+
+ Specifies that the SPICE server must use TLS to encrypt all the
+ traffic with the client.
+
+spice\_tls\_ciphers
+ Valid for the KVM hypervisor.
+
+ Specifies a list of comma-separated ciphers that SPICE should use
+ for TLS connections. For the format, see man cipher(1).
+
+spice\_use\_vdagent
+ Valid for the KVM hypervisor.
+
+ Enables or disables passing mouse events via SPICE vdagent.
+
acpi
Valid for the Xen HVM and KVM hypervisors.
This option specifies the path (on the node) to the kernel to boot
the instance with. Xen PVM instances always require this, while for
KVM if this option is empty, it will cause the machine to load the
- kernel from its disks.
+ kernel from its disks (and the boot will be done accordingly to
+ ``boot_order``).
kernel\_args
Valid for the Xen PVM and KVM hypervisors.
loaded. device. This is always used for Xen PVM, while for KVM it
is only used if the ``kernel_path`` option is also specified.
- The default setting for this value is simply ``"ro"``, which mounts
- the root disk (initially) in read-only one. For example, setting
- this to single will cause the instance to start in single-user
- mode.
+ The default setting for this value is simply ``"ro"``, which
+ mounts the root disk (initially) in read-only one. For example,
+ setting this to single will cause the instance to start in
+ single-user mode.
initrd\_path
Valid for the Xen PVM and KVM hypervisors.
This option specifies the path (on the node) to the initrd to boot
- the instance with. Xen PVM instances can use this always, while for
- KVM if this option is only used if the ``kernel_path`` option is
- also specified. You can pass here either an absolute filename (the
- path to the initrd) if you want to use an initrd, or use the format
- no\_initrd\_path for no initrd.
+ the instance with. Xen PVM instances can use this always, while
+ for KVM if this option is only used if the ``kernel_path`` option
+ is also specified. You can pass here either an absolute filename
+ (the path to the initrd) if you want to use an initrd, or use the
+ format no\_initrd\_path for no initrd.
root\_path
Valid for the Xen PVM and KVM hypervisors.
needed for Xen PVM, while for KVM it is only used if the
``kernel_path`` option is also specified.
+ Please note, that if this setting is an empty string and the
+ hypervisor is Xen it will not be written to the Xen configuration
+ file
+
serial\_console
Valid for the KVM hypervisor.
disk\_cache
Valid for the KVM hypervisor.
- The disk cache mode. It can be either default to not pass any cache
- option to KVM, or one of the KVM cache modes: none (for direct
- I/O), writethrough (to use the host cache but report completion to
- the guest only when the host has committed the changes to disk) or
- writeback (to use the host cache and report completion as soon as
- the data is in the host cache). Note that there are special
- considerations for the cache mode depending on version of KVM used
- and disk type (always raw file under Ganeti), please refer to the
- KVM documentation for more details.
+ The disk cache mode. It can be either default to not pass any
+ cache option to KVM, or one of the KVM cache modes: none (for
+ direct I/O), writethrough (to use the host cache but report
+ completion to the guest only when the host has committed the
+ changes to disk) or writeback (to use the host cache and report
+ completion as soon as the data is in the host cache). Note that
+ there are special considerations for the cache mode depending on
+ version of KVM used and disk type (always raw file under Ganeti),
+ please refer to the KVM documentation for more details.
security\_model
Valid for the KVM hypervisor.
- The security model for kvm. Currently one of "none", "user" or
- "pool". Under "none", the default, nothing is done and instances
+ The security model for kvm. Currently one of *none*, *user* or
+ *pool*. Under *none*, the default, nothing is done and instances
are run as the Ganeti daemon user (normally root).
- Under "user" kvm will drop privileges and become the user specified
- by the security\_domain parameter.
+ Under *user* kvm will drop privileges and become the user
+ specified by the security\_domain parameter.
- Under "pool" a global cluster pool of users will be used, making
+ Under *pool* a global cluster pool of users will be used, making
sure no two instances share the same user on the same node. (this
mode is not implemented yet)
security\_domain
Valid for the KVM hypervisor.
- Under security model "user" the username to run the instance under.
- It must be a valid username existing on the host.
+ Under security model *user* the username to run the instance
+ under. It must be a valid username existing on the host.
- Cannot be set under security model "none" or "pool".
+ Cannot be set under security model *none* or *pool*.
kvm\_flag
Valid for the KVM hypervisor.
- If "enabled" the -enable-kvm flag is passed to kvm. If "disabled"
- -disable-kvm is passed. If unset no flag is passed, and the default
- running mode for your kvm binary will be used.
+ If *enabled* the -enable-kvm flag is passed to kvm. If *disabled*
+ -disable-kvm is passed. If unset no flag is passed, and the
+ default running mode for your kvm binary will be used.
mem\_path
Valid for the KVM hypervisor.
use\_chroot
Valid for the KVM hypervisor.
- This boolean option determines wether to run the KVM instance in a
+ This boolean option determines whether to run the KVM instance in a
chroot directory.
If it is set to ``true``, an empty directory is created before
versions >= 0.11.0.
cpu\_mask
- Valid for the LXC hypervisor.
+ Valid for the Xen, KVM and LXC hypervisors.
+
+ The processes belonging to the given instance are only scheduled
+ on the specified CPUs.
+
+ The format of the mask can be given in three forms. First, the word
+ "all", which signifies the common case where all VCPUs can live on
+ any CPU, based on the hypervisor's decisions.
+
+ Second, a comma-separated list of CPU IDs or CPU ID ranges. The
+ ranges are defined by a lower and higher boundary, separated by a
+ dash, and the boundaries are inclusive. In this form, all VCPUs of
+ the instance will be mapped on the selected list of CPUs. Example:
+ ``0-2,5``, mapping all VCPUs (no matter how many) onto physical CPUs
+ 0, 1, 2 and 5.
+
+ The last form is used for explicit control of VCPU-CPU pinnings. In
+ this form, the list of VCPU mappings is given as a colon (:)
+ separated list, whose elements are the possible values for the
+ second or first form above. In this form, the number of elements in
+ the colon-separated list _must_ equal the number of VCPUs of the
+ instance.
+
+ Example::
+
+ # Map the entire instance to CPUs 0-2
+ gnt-instance modify -H cpu_mask=0-2 my-inst
+
+ # Map vCPU 0 to physical CPU 1 and vCPU 1 to CPU 3 (assuming 2 vCPUs)
+ gnt-instance modify -H cpu_mask=1:3 my-inst
+
+ # Pin vCPU 0 to CPUs 1 or 2, and vCPU 1 to any CPU
+ gnt-instance modify -H cpu_mask=1-2:all my-inst
+
+ # Pin vCPU 0 to any CPU, vCPU 1 to CPUs 1, 3, 4 or 5, and CPU 2 to
+ # CPU 0 (backslashes for escaping the comma)
+ gnt-instance modify -H cpu_mask=all:1\\,3-5:0 my-inst
- The processes belonging to the given instance are only scheduled on
- the specified CPUs.
+ # Pin entire VM to CPU 0
+ gnt-instance modify -H cpu_mask=0 my-inst
- The parameter format is a comma-separated list of CPU IDs or CPU ID
- ranges. The ranges are defined by a lower and higher boundary,
- separated by a dash. The boundaries are inclusive.
+ # Turn off CPU pinning (default setting)
+ gnt-instance modify -H cpu_mask=all my-inst
usb\_mouse
Valid for the KVM hypervisor.
"mouse" or "tablet". When using VNC it's recommended to set it to
"tablet".
+keymap
+ Valid for the KVM hypervisor.
+
+ This option specifies the keyboard mapping to be used. It is only
+ needed when using the VNC console. For example: "fr" or "en-gb".
+
+reboot\_behavior
+ Valid for Xen PVM, Xen HVM and KVM hypervisors.
+
+ Normally if an instance reboots, the hypervisor will restart it. If
+ this option is set to ``exit``, the hypervisor will treat a reboot
+ as a shutdown instead.
+
+ It is set to ``reboot`` by default.
+
-The ``-O`` (``--os-parameters``) option allows customisation of the OS
+The ``-O (--os-parameters)`` option allows customisation of the OS
parameters. The actual parameter names and values depends on the OS
being used, but the syntax is the same key=value. For example, setting
a hypothetical ``dhcp`` parameter to yes can be achieved by::
gnt-instance add -O dhcp=yes ...
-
-The ``--iallocator`` option specifies the instance allocator plugin
-to use. If you pass in this option the allocator will select nodes
-for this instance automatically, so you don't need to pass them
+The ``-I (--iallocator)`` option specifies the instance allocator
+plugin to use. If you pass in this option the allocator will select
+nodes for this instance automatically, so you don't need to pass them
with the ``-n`` option. For more information please refer to the
instance allocator documentation.
-The ``-t`` options specifies the disk layout type for the instance.
-The available choices are:
-
-
+The ``-t (--disk-template)`` options specifies the disk layout type
+for the instance. The available choices are:
diskless
This creates an instance with no disks. Its useful for testing only
drbd
Disk devices will be drbd (version 8.x) on top of lvm volumes.
+rbd
+ Disk devices will be rbd volumes residing inside a RADOS cluster.
-The optional second value of the ``--node`` is used for the drbd
+
+The optional second value of the ``-n (--node)`` is used for the drbd
template type and specifies the remote node.
If you do not want gnt-instance to wait for the disk mirror to be
option is only relevant for instances using the file storage backend.
The ``--file-driver`` specifies the driver to use for file-based
-disks. Note that currently these drivers work with the xen
-hypervisor only. This option is only relevant for instances using
-the file storage backend. The available choices are:
-
-
+disks. Note that currently these drivers work with the xen hypervisor
+only. This option is only relevant for instances using the file
+storage backend. The available choices are:
loop
- Kernel loopback driver. This driver uses loopback devices to access
- the filesystem within the file. However, running I/O intensive
- applications in your instance using the loop driver might result in
- slowdowns. Furthermore, if you use the loopback driver consider
- increasing the maximum amount of loopback devices (on most systems
- it's 8) using the max\_loop param.
+ Kernel loopback driver. This driver uses loopback devices to
+ access the filesystem within the file. However, running I/O
+ intensive applications in your instance using the loop driver
+ might result in slowdowns. Furthermore, if you use the loopback
+ driver consider increasing the maximum amount of loopback devices
+ (on most systems it's 8) using the max\_loop param.
blktap
- The blktap driver (for Xen hypervisors). In order to be able to use
- the blktap driver you should check if the 'blktapctrl' user space
- disk agent is running (usually automatically started via xend).
- This user-level disk I/O interface has the advantage of better
- performance. Especially if you use a network file system (e.g. NFS)
- to store your instances this is the recommended choice.
+ The blktap driver (for Xen hypervisors). In order to be able to
+ use the blktap driver you should check if the 'blktapctrl' user
+ space disk agent is running (usually automatically started via
+ xend). This user-level disk I/O interface has the advantage of
+ better performance. Especially if you use a network file system
+ (e.g. NFS) to store your instances this is the recommended choice.
+If ``--ignore-ipolicy`` is given any instance policy violations occuring
+during this operation are ignored.
-The ``--submit`` option is used to send the job to the master
-daemon but not wait for its completion. The job ID will be shown so
-that it can be examined via **gnt-job info**.
+See **ganeti(7)** for a description of ``--submit`` and other common
+options.
Example::
- # gnt-instance add -t file --disk 0:size=30g -B memory=512 -o debian-etch \
+ # gnt-instance add -t file --disk 0:size=30g -B maxmem=512 -o debian-etch \
-n node1.example.com --file-storage-dir=mysubdir instance1.example.com
- # gnt-instance add -t plain --disk 0:size=30g -B memory=512 -o debian-etch \
- -n node1.example.com instance1.example.com
+ # gnt-instance add -t plain --disk 0:size=30g -B maxmem=1024,minmem=512 \
+ -o debian-etch -n node1.example.com instance1.example.com
# gnt-instance add -t plain --disk 0:size=30g --disk 1:size=100g,vg=san \
- -B memory=512 -o debian-etch -n node1.example.com instance1.example.com
- # gnt-instance add -t drbd --disk 0:size=30g -B memory=512 -o debian-etch \
+ -B maxmem=512 -o debian-etch -n node1.example.com instance1.example.com
+ # gnt-instance add -t drbd --disk 0:size=30g -B maxmem=512 -o debian-etch \
-n node1.example.com:node2.example.com instance2.example.com
This command (similar to the Ganeti 1.2 **batcher** tool) submits
multiple instance creation jobs based on a definition file. The
-instance configurations do not encompass all the possible options
-for the **add** command, but only a subset.
+instance configurations do not encompass all the possible options for
+the **add** command, but only a subset.
The instance file should be a valid-formed JSON file, containing a
dictionary with instance name and instance parameters. The accepted
parameters are:
-
-
disk\_size
The size of the disks of the instance.
mac, ip, mode, link
Specifications for the one NIC that will be created for the
- instance. 'bridge' is also accepted as a backwards compatibile
+ instance. 'bridge' is also accepted as a backwards compatible
key.
nics
"iallocator": "dumb",
"hypervisor": "xen-hvm",
"hvparams": {"acpi": true},
- "backend": {"memory": 512}
+ "backend": {"maxmem": 512, "minmem": 256}
}
}
REMOVE
^^^^^^
-**remove** [--ignore-failures] [--shutdown-timeout=*N*] [--submit]
-{*instance*}
+**remove** [\--ignore-failures] [\--shutdown-timeout=*N*] [\--submit]
+[\--force] {*instance*}
Remove an instance. This will remove all data from the instance and
there is *no way back*. If you are not sure if you use an instance
-again, use **shutdown** first and leave it in the shutdown state
-for a while.
+again, use **shutdown** first and leave it in the shutdown state for a
+while.
The ``--ignore-failures`` option will cause the removal to proceed
even in the presence of errors during the removal of the instance
-(e.g. during the shutdown or the disk removal). If this option is
-not given, the command will stop at the first error.
+(e.g. during the shutdown or the disk removal). If this option is not
+given, the command will stop at the first error.
The ``--shutdown-timeout`` is used to specify how much time to wait
before forcing the shutdown (e.g. ``xm destroy`` in Xen, killing the
kvm process for KVM, etc.). By default two minutes are given to each
instance to stop.
-The ``--submit`` option is used to send the job to the master
-daemon but not wait for its completion. The job ID will be shown so
-that it can be examined via **gnt-job info**.
+The ``--force`` option is used to skip the interactive confirmation.
+
+See **ganeti(7)** for a description of ``--submit`` and other common
+options.
Example::
^^^^
| **list**
-| [--no-headers] [--separator=*SEPARATOR*] [--units=*UNITS*] [-v]
-| [-o *[+]FIELD,...*] [instance...]
+| [\--no-headers] [\--separator=*SEPARATOR*] [\--units=*UNITS*] [-v]
+| [{-o|\--output} *[+]FIELD,...*] [\--filter] [instance...]
Shows the currently configured instances with memory usage, disk
usage, the node they are running on, and their run status.
The units used to display the numeric values in the output varies,
depending on the options given. By default, the values will be
-formatted in the most appropriate unit. If the ``--separator``
-option is given, then the values are shown in mebibytes to allow
-parsing by scripts. In both cases, the ``--units`` option can be
-used to enforce a given output unit.
+formatted in the most appropriate unit. If the ``--separator`` option
+is given, then the values are shown in mebibytes to allow parsing by
+scripts. In both cases, the ``--units`` option can be used to enforce
+a given output unit.
The ``-v`` option activates verbose mode, which changes the display of
special field states (see **ganeti(7)**).
-The ``-o`` option takes a comma-separated list of output fields.
-The available fields and their meaning are:
-
-
-name
- the instance name
-
-os
- the OS of the instance
-
-pnode
- the primary node of the instance
-
-snodes
- comma-separated list of secondary nodes for the instance; usually
- this will be just one node
-
-admin\_state
- the desired state of the instance (either "yes" or "no" denoting
- the instance should run or not)
-
-disk\_template
- the disk template of the instance
-
-oper\_state
- the actual state of the instance; can be one of the values
- "running", "stopped", "(node down)"
-
-status
- combined form of ``admin_state`` and ``oper_stat``; this can be one of:
- ``ERROR_nodedown`` if the node of the instance is down, ``ERROR_down`` if
- the instance should run but is down, ``ERROR_up`` if the instance should be
- stopped but is actually running, ``ERROR_wrongnode`` if the instance is
- running but not on the primary, ``ADMIN_down`` if the instance has been
- stopped (and is stopped) and ``running`` if the instance is set to be
- running (and is running)
-
-oper\_ram
- the actual memory usage of the instance as seen by the hypervisor
-
-oper\_vcpus
- the actual number of VCPUs the instance is using as seen by the
- hypervisor
-
-ip
- the ip address Ganeti recognizes as associated with the first
- instance interface
-
-mac
- the first instance interface MAC address
-
-nic\_mode
- the mode of the first instance NIC (routed or bridged)
-
-nic\_link
- the link of the first instance NIC
-
-sda\_size
- the size of the instance's first disk
-
-sdb\_size
- the size of the instance's second disk, if any
-
-vcpus
- the number of VCPUs allocated to the instance
-
-tags
- comma-separated list of the instances's tags
-
-serial\_no
- the so called 'serial number' of the instance; this is a numeric
- field that is incremented each time the instance is modified, and
- it can be used to track modifications
-
-ctime
- the creation time of the instance; note that this field contains
- spaces and as such it's harder to parse
-
- if this attribute is not present (e.g. when upgrading from older
- versions), then "N/A" will be shown instead
-
-mtime
- the last modification time of the instance; note that this field
- contains spaces and as such it's harder to parse
-
- if this attribute is not present (e.g. when upgrading from older
- versions), then "N/A" will be shown instead
-
-uuid
- Show the UUID of the instance (generated automatically by Ganeti)
-
-network\_port
- If the instance has a network port assigned to it (e.g. for VNC
- connections), this will be shown, otherwise - will be displayed.
-
-beparams
- A text format of the entire beparams for the instance. It's more
- useful to select individual fields from this dictionary, see
- below.
-
-disk.count
- The number of instance disks.
-
-disk.size/N
- The size of the instance's Nth disk. This is a more generic form of
- the sda\_size and sdb\_size fields.
-
-disk.sizes
- A comma-separated list of the disk sizes for this instance.
-
-disk\_usage
- The total disk space used by this instance on each of its nodes.
- This is not the instance-visible disk size, but the actual disk
- "cost" of the instance.
-
-nic.mac/N
- The MAC of the Nth instance NIC.
-
-nic.ip/N
- The IP address of the Nth instance NIC.
-
-nic.mode/N
- The mode of the Nth instance NIC
-
-nic.link/N
- The link of the Nth instance NIC
-
-nic.macs
- A comma-separated list of all the MACs of the instance's NICs.
-
-nic.ips
- A comma-separated list of all the IP addresses of the instance's
- NICs.
-
-nic.modes
- A comma-separated list of all the modes of the instance's NICs.
-
-nic.links
- A comma-separated list of all the link parameters of the instance's
- NICs.
-
-nic.count
- The number of instance nics.
-
-hv/*NAME*
- The value of the hypervisor parameter called *NAME*. For details of
- what hypervisor parameters exist and their meaning, see the **add**
- command.
-
-be/memory
- The configured memory for the instance.
-
-be/vcpus
- The configured number of VCPUs for the instance.
-
-be/auto\_balance
- Whether the instance is considered in N+1 checks.
+The ``-o (--output)`` option takes a comma-separated list of output
+fields. The available fields and their meaning are:
+@QUERY_FIELDS_INSTANCE@
If the value of the option starts with the character ``+``, the new
-field(s) will be added to the default list. This allows to quickly
-see the default list plus a few other fields, instead of retyping
-the entire list of fields.
+field(s) will be added to the default list. This allows one to quickly
+see the default list plus a few other fields, instead of retyping the
+entire list of fields.
There is a subtle grouping about the available output fields: all
fields except for ``oper_state``, ``oper_ram``, ``oper_vcpus`` and
-``status`` are configuration value and not run-time values. So if
-you don't select any of the these fields, the query will be
-satisfied instantly from the cluster configuration, without having
-to ask the remote nodes for the data. This can be helpful for big
-clusters when you only want some data and it makes sense to specify
-a reduced set of output fields.
+``status`` are configuration value and not run-time values. So if you
+don't select any of the these fields, the query will be satisfied
+instantly from the cluster configuration, without having to ask the
+remote nodes for the data. This can be helpful for big clusters when
+you only want some data and it makes sense to specify a reduced set of
+output fields.
-The default output field list is: name, os, pnode, admin\_state,
-oper\_state, oper\_ram.
+If exactly one argument is given and it appears to be a query filter
+(see **ganeti(7)**), the query result is filtered accordingly. For
+ambiguous cases (e.g. a single field name as a filter) the ``--filter``
+(``-F``) option forces the argument to be treated as a filter (e.g.
+``gnt-instance list -F admin_state``).
+
+The default output field list is: ``name``, ``os``, ``pnode``,
+``admin_state``, ``oper_state``, ``oper_ram``.
LIST-FIELDS
INFO
^^^^
-**info** [-s \| --static] [--roman] {--all \| *instance*}
+**info** [-s \| \--static] [\--roman] {\--all \| *instance*}
Show detailed information about the given instance(s). This is
-different from **list** as it shows detailed data about the
-instance's disks (especially useful for the drbd disk template).
+different from **list** as it shows detailed data about the instance's
+disks (especially useful for the drbd disk template).
If the option ``-s`` is used, only information available in the
configuration file is returned, without querying nodes, making the
Use the ``--all`` to get info about all instances, rather than
explicitly passing the ones you're interested in.
-The ``--roman`` option can be used to cause envy among people who
-like ancient cultures, but are stuck with non-latin-friendly
-cluster virtualization technologies.
+The ``--roman`` option can be used to cause envy among people who like
+ancient cultures, but are stuck with non-latin-friendly cluster
+virtualization technologies.
MODIFY
^^^^^^
| **modify**
-| [-H *HYPERVISOR\_PARAMETERS*]
-| [-B *BACKEND\_PARAMETERS*]
-| [--net add*[:options]* \| --net remove \| --net *N:options*]
-| [--disk add:size=*SIZE*[,vg=*VG*] \| --disk remove \|
-| --disk *N*:mode=*MODE*]
-| [-t plain | -t drbd -n *new_secondary*]
-| [--os-type=*OS* [--force-variant]]
-| [-O, --os-parameters *param*=*value*... ]
-| [--submit]
+| [{-H|\--hypervisor-parameters} *HYPERVISOR\_PARAMETERS*]
+| [{-B|\--backend-parameters} *BACKEND\_PARAMETERS*]
+| [{-m|\--runtime-memory} *SIZE*]
+| [\--net add*[:options]* \| \--net remove \| \--net *N:options*]
+| [\--disk add:size=*SIZE*[,vg=*VG*][,metavg=*VG*] \| \--disk remove \|
+| \--disk *N*:mode=*MODE*]
+| [{-t|\--disk-template} plain | {-t|\--disk-template} drbd -n *new_secondary*] [\--no-wait-for-sync]
+| [\--os-type=*OS* [\--force-variant]]
+| [{-O|\--os-parameters} *param*=*value*... ]
+| [\--offline \| \--online]
+| [\--submit]
+| [\--ignore-ipolicy]
| {*instance*}
Modifies the memory size, number of vcpus, ip address, MAC address
disks and NICs to/from the instance. Note that you need to give at
least one of the arguments, otherwise the command complains.
-The ``-H``, ``-B`` and ``-O`` options specifies hypervisor, backend
-and OS parameter options in the form of name=value[,...]. For details
+The ``-H (--hypervisor-parameters)``, ``-B (--backend-parameters)``
+and ``-O (--os-parameters)`` options specifies hypervisor, backend and
+OS parameter options in the form of name=value[,...]. For details
which options can be specified, see the **add** command.
-The ``-t`` option will change the disk template of the instance.
-Currently only conversions between the plain and drbd disk templates
-are supported, and the instance must be stopped before attempting the
-conversion. When changing from the plain to the drbd disk template, a
-new secondary node must be specified via the ``-n`` option.
+The ``-t (--disk-template)`` option will change the disk template of
+the instance. Currently only conversions between the plain and drbd
+disk templates are supported, and the instance must be stopped before
+attempting the conversion. When changing from the plain to the drbd
+disk template, a new secondary node must be specified via the ``-n``
+option. The option ``--no-wait-for-sync`` can be used when converting
+to the ``drbd`` template in order to make the instance available for
+startup before DRBD has finished resyncing.
+
+The ``-m (--runtime-memory)`` option will change an instance's runtime
+memory to the given size (in MB if a different suffix is not specified),
+by ballooning it up or down to the new value.
The ``--disk add:size=``*SIZE* option adds a disk to the instance. The
-optional ``vg=``*VG* option specifies LVM volume group other than default
-vg to create disk on. The ``--disk remove`` option will remove the last
-disk of the instance. The ``--disk`` *N*``:mode=``*MODE* option will change
+optional ``vg=``*VG* option specifies an LVM volume group other than
+the default volume group to create the disk on. For DRBD disks, the
+``metavg=``*VG* option specifies the volume group for the metadata
+device. ``--disk`` *N*``:add,size=``**SIZE** can be used to add a
+disk at a specific index. The ``--disk remove`` option will remove the
+last disk of the instance. Use ``--disk `` *N*``:remove`` to remove a
+disk by its index. The ``--disk`` *N*``:mode=``*MODE* option will change
the mode of the Nth disk of the instance between read-only (``ro``) and
read-write (``rw``).
-The ``--net add:``*options* option will add a new NIC to the
-instance. The available options are the same as in the **add** command
-(mac, ip, link, mode). The ``--net remove`` will remove the last NIC
-of the instance, while the ``--net`` *N*:*options* option will
-change the parameters of the Nth instance NIC.
-
-The option ``--os-type`` will change the OS name for the instance
-(without reinstallation). In case an OS variant is specified that
-is not found, then by default the modification is refused, unless
+The ``--net add:``*options* and ``--net`` *N*``:add,``*options* option
+will add a new network interface to the instance. The available options
+are the same as in the **add** command (``mac``, ``ip``, ``link``,
+``mode``). The ``--net remove`` will remove the last network interface
+of the instance (``--net`` *N*``:remove`` for a specific index), while
+the ``--net`` *N*``:``*options* option will change the parameters of the Nth
+instance network interface.
+
+The option ``-o (--os-type)`` will change the OS name for the instance
+(without reinstallation). In case an OS variant is specified that is
+not found, then by default the modification is refused, unless
``--force-variant`` is passed. An invalid OS will also be refused,
unless the ``--force`` option is given.
-The ``--submit`` option is used to send the job to the master
-daemon but not wait for its completion. The job ID will be shown so
-that it can be examined via **gnt-job info**.
+The ``--online`` and ``--offline`` options are used to transition an
+instance into and out of the ``offline`` state. An instance can be
+turned offline only if it was previously down. The ``--online`` option
+fails if the instance was not in the ``offline`` state, otherwise it
+changes instance's state to ``down``. These modifications take effect
+immediately.
+
+If ``--ignore-ipolicy`` is given any instance policy violations occuring
+during this operation are ignored.
+
+See **ganeti(7)** for a description of ``--submit`` and other common
+options.
-All the changes take effect at the next restart. If the instance is
+Most of the changes take effect at the next restart. If the instance is
running, there is no effect on the instance.
REINSTALL
^^^^^^^^^
-| **reinstall** [-o *os-type*] [--select-os] [-f *force*]
-| [--force-multiple]
-| [--instance \| --node \| --primary \| --secondary \| --all]
-| [-O *OS\_PARAMETERS*] [--submit] {*instance*...}
+| **reinstall** [{-o|\--os-type} *os-type*] [\--select-os] [-f *force*]
+| [\--force-multiple]
+| [\--instance \| \--node \| \--primary \| \--secondary \| \--all]
+| [{-O|\--os-parameters} *OS\_PARAMETERS*] [\--submit] {*instance*...}
Reinstalls the operating system on the given instance(s). The
-instance(s) must be stopped when running this command. If the
-``--os-type`` is specified, the operating system is changed.
+instance(s) must be stopped when running this command. If the ``-o
+(--os-type)`` is specified, the operating system is changed.
The ``--select-os`` option switches to an interactive OS reinstall.
The user is prompted to select the OS template from the list of
-available OS templates. OS parameters can be overridden using ``-O``
-(more documentation for this option under the **add** command).
+available OS templates. OS parameters can be overridden using ``-O
+(--os-parameters)`` (more documentation for this option under the
+**add** command).
Since this is a potentially dangerous command, the user will be
required to confirm this action, unless the ``-f`` flag is passed.
When multiple instances are selected (either by passing multiple
-arguments or by using the ``--node``, ``--primary``,
-``--secondary`` or ``--all`` options), the user must pass the
-``--force-multiple`` options to skip the interactive confirmation.
+arguments or by using the ``--node``, ``--primary``, ``--secondary``
+or ``--all`` options), the user must pass the ``--force-multiple``
+options to skip the interactive confirmation.
-The ``--submit`` option is used to send the job to the master
-daemon but not wait for its completion. The job ID will be shown so
-that it can be examined via **gnt-job info**.
+See **ganeti(7)** for a description of ``--submit`` and other common
+options.
RENAME
^^^^^^
-| **rename** [--no-ip-check] [--no-name-check] [--submit]
+| **rename** [\--no-ip-check] [\--no-name-check] [\--submit]
| {*instance*} {*new\_name*}
-Renames the given instance. The instance must be stopped when
-running this command. The requirements for the new name are the
-same as for adding an instance: the new name must be resolvable and
-the IP it resolves to must not be reachable (in order to prevent
-duplicate IPs the next time the instance is started). The IP test
-can be skipped if the ``--no-ip-check`` option is passed.
+Renames the given instance. The instance must be stopped when running
+this command. The requirements for the new name are the same as for
+adding an instance: the new name must be resolvable and the IP it
+resolves to must not be reachable (in order to prevent duplicate IPs
+the next time the instance is started). The IP test can be skipped if
+the ``--no-ip-check`` option is passed.
-The ``--no-name-check`` skips the check for the new instance name
-via the resolver (e.g. in DNS or /etc/hosts, depending on your
-setup). Since the name check is used to compute the IP address, if
-you pass this option you must also pass the ``--no-ip-check``
-option.
+The ``--no-name-check`` skips the check for the new instance name via
+the resolver (e.g. in DNS or /etc/hosts, depending on your setup) and
+that the resolved name matches the provided name. Since the name check
+is used to compute the IP address, if you pass this option you must also
+pass the ``--no-ip-check`` option.
-The ``--submit`` option is used to send the job to the master
-daemon but not wait for its completion. The job ID will be shown so
-that it can be examined via **gnt-job info**.
+See **ganeti(7)** for a description of ``--submit`` and other common
+options.
Starting/stopping/connecting to console
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
^^^^^^^
| **startup**
-| [--force] [--ignore-offline]
-| [--force-multiple]
-| [--instance \| --node \| --primary \| --secondary \| --all \|
-| --tags \| --node-tags \| --pri-node-tags \| --sec-node-tags]
-| [-H ``key=value...``] [-B ``key=value...``]
-| [--submit]
+| [\--force] [\--ignore-offline]
+| [\--force-multiple] [\--no-remember]
+| [\--instance \| \--node \| \--primary \| \--secondary \| \--all \|
+| \--tags \| \--node-tags \| \--pri-node-tags \| \--sec-node-tags]
+| [{-H|\--hypervisor-parameters} ``key=value...``]
+| [{-B|\--backend-parameters} ``key=value...``]
+| [\--submit] [\--paused]
| {*name*...}
-Starts one or more instances, depending on the following options.
-The four available modes are:
+Starts one or more instances, depending on the following options. The
+four available modes are:
-
---instance
+\--instance
will start the instances given as arguments (at least one argument
required); this is the default selection
---node
+\--node
will start the instances who have the given node as either primary
or secondary
---primary
+\--primary
will start all instances whose primary node is in the list of nodes
passed as arguments (at least one node required)
---secondary
+\--secondary
will start all instances whose secondary node is in the list of
nodes passed as arguments (at least one node required)
---all
+\--all
will start all instances in the cluster (no arguments accepted)
---tags
+\--tags
will start all instances in the cluster with the tags given as
arguments
---node-tags
+\--node-tags
will start all instances in the cluster on nodes with the tags
given as arguments
---pri-node-tags
+\--pri-node-tags
will start all instances in the cluster on primary nodes with the
tags given as arguments
---sec-node-tags
+\--sec-node-tags
will start all instances in the cluster on secondary nodes with the
tags given as arguments
-
Note that although you can pass more than one selection option, the
-last one wins, so in order to guarantee the desired result, don't
-pass more than one such option.
+last one wins, so in order to guarantee the desired result, don't pass
+more than one such option.
Use ``--force`` to start even if secondary disks are failing.
-``--ignore-offline`` can be used to ignore offline primary nodes
-and mark the instance as started even if the primary is not
-available.
+``--ignore-offline`` can be used to ignore offline primary nodes and
+mark the instance as started even if the primary is not available.
+
+The ``--force-multiple`` will skip the interactive confirmation in the
+case the more than one instance will be affected.
-The ``--force-multiple`` will skip the interactive confirmation in
-the case the more than one instance will be affected.
+The ``--no-remember`` option will perform the startup but not change
+the state of the instance in the configuration file (if it was stopped
+before, Ganeti will still thinks it needs to be stopped). This can be
+used for testing, or for a one shot-start where you don't want the
+watcher to restart the instance if it crashes.
-The ``-H`` and ``-B`` options specify temporary hypervisor and
-backend parameters that can be used to start an instance with
-modified parameters. They can be useful for quick testing without
-having to modify an instance back and forth, e.g.::
+The ``-H (--hypervisor-parameters)`` and ``-B (--backend-parameters)``
+options specify temporary hypervisor and backend parameters that can
+be used to start an instance with modified parameters. They can be
+useful for quick testing without having to modify an instance back and
+forth, e.g.::
- # gnt-instance start -H root_args="single" instance1
- # gnt-instance start -B memory=2048 instance2
+ # gnt-instance start -H kernel_args="single" instance1
+ # gnt-instance start -B maxmem=2048 instance2
-The first form will start the instance instance1 in single-user
-mode, and the instance instance2 with 2GB of RAM (this time only,
-unless that is the actual instance memory size already). Note that
-the values override the instance parameters (and not extend them):
-an instance with "root\_args=ro" when started with -H
-root\_args=single will result in "single", not "ro single".
-The ``--submit`` option is used to send the job to the master
-daemon but not wait for its completion. The job ID will be shown so
-that it can be examined via **gnt-job info**.
+The first form will start the instance instance1 in single-user mode,
+and the instance instance2 with 2GB of RAM (this time only, unless
+that is the actual instance memory size already). Note that the values
+override the instance parameters (and not extend them): an instance
+with "kernel\_args=ro" when started with -H kernel\_args=single will
+result in "single", not "ro single".
+
+The ``--paused`` option is only valid for Xen and kvm hypervisors. This
+pauses the instance at the start of bootup, awaiting ``gnt-instance
+console`` to unpause it, allowing the entire boot process to be
+monitored for debugging.
+
+See **ganeti(7)** for a description of ``--submit`` and other common
+options.
Example::
^^^^^^^^
| **shutdown**
-| [--timeout=*N*]
-| [--force-multiple] [--ignore-offline]
-| [--instance \| --node \| --primary \| --secondary \| --all \|
-| --tags \| --node-tags \| --pri-node-tags \| --sec-node-tags]
-| [--submit]
+| [\--timeout=*N*]
+| [\--force-multiple] [\--ignore-offline] [\--no-remember]
+| [\--instance \| \--node \| \--primary \| \--secondary \| \--all \|
+| \--tags \| \--node-tags \| \--pri-node-tags \| \--sec-node-tags]
+| [\--submit]
| {*name*...}
-Stops one or more instances. If the instance cannot be cleanly
-stopped during a hardcoded interval (currently 2 minutes), it will
-forcibly stop the instance (equivalent to switching off the power
-on a physical machine).
+Stops one or more instances. If the instance cannot be cleanly stopped
+during a hardcoded interval (currently 2 minutes), it will forcibly
+stop the instance (equivalent to switching off the power on a physical
+machine).
The ``--timeout`` is used to specify how much time to wait before
forcing the shutdown (e.g. ``xm destroy`` in Xen, killing the kvm
The ``--instance``, ``--node``, ``--primary``, ``--secondary``,
``--all``, ``--tags``, ``--node-tags``, ``--pri-node-tags`` and
-``--sec-node-tags`` options are similar as for the **startup**
-command and they influence the actual instances being shutdown.
+``--sec-node-tags`` options are similar as for the **startup** command
+and they influence the actual instances being shutdown.
+
+``--ignore-offline`` can be used to ignore offline primary nodes and
+force the instance to be marked as stopped. This option should be used
+with care as it can lead to an inconsistent cluster state.
-The ``--submit`` option is used to send the job to the master
-daemon but not wait for its completion. The job ID will be shown so
-that it can be examined via **gnt-job info**.
+The ``--no-remember`` option will perform the shutdown but not change
+the state of the instance in the configuration file (if it was running
+before, Ganeti will still thinks it needs to be running). This can be
+useful for a cluster-wide shutdown, where some instances are marked as
+up and some as down, and you don't want to change the running state:
+you just need to disable the watcher, shutdown all instances with
+``--no-remember``, and when the watcher is activated again it will
+restore the correct runtime state for all instances.
-``--ignore-offline`` can be used to ignore offline primary nodes
-and force the instance to be marked as stopped. This option should
-be used with care as it can lead to an inconsistent cluster state.
+See **ganeti(7)** for a description of ``--submit`` and other common
+options.
Example::
^^^^^^
| **reboot**
-| [--type=*REBOOT-TYPE*]
-| [--ignore-secondaries]
-| [--shutdown-timeout=*N*]
-| [--force-multiple]
-| [--instance \| --node \| --primary \| --secondary \| --all \|
-| --tags \| --node-tags \| --pri-node-tags \| --sec-node-tags]
-| [--submit]
+| [{-t|\--type} *REBOOT-TYPE*]
+| [\--ignore-secondaries]
+| [\--shutdown-timeout=*N*]
+| [\--force-multiple]
+| [\--instance \| \--node \| \--primary \| \--secondary \| \--all \|
+| \--tags \| \--node-tags \| \--pri-node-tags \| \--sec-node-tags]
+| [\--submit]
| [*name*...]
-Reboots one or more instances. The type of reboot depends on the
-value of ``--type``. A soft reboot does a hypervisor reboot, a hard
-reboot does a instance stop, recreates the hypervisor config for
-the instance and starts the instance. A full reboot does the
-equivalent of **gnt-instance shutdown && gnt-instance startup**.
-The default is hard reboot.
+Reboots one or more instances. The type of reboot depends on the value
+of ``-t (--type)``. A soft reboot does a hypervisor reboot, a hard reboot
+does a instance stop, recreates the hypervisor config for the instance
+and starts the instance. A full reboot does the equivalent of
+**gnt-instance shutdown && gnt-instance startup**. The default is
+hard reboot.
-For the hard reboot the option ``--ignore-secondaries`` ignores
-errors for the secondary node while re-assembling the instance
-disks.
+For the hard reboot the option ``--ignore-secondaries`` ignores errors
+for the secondary node while re-assembling the instance disks.
The ``--instance``, ``--node``, ``--primary``, ``--secondary``,
``--all``, ``--tags``, ``--node-tags``, ``--pri-node-tags`` and
-``--sec-node-tags`` options are similar as for the **startup**
-command and they influence the actual instances being rebooted.
+``--sec-node-tags`` options are similar as for the **startup** command
+and they influence the actual instances being rebooted.
The ``--shutdown-timeout`` is used to specify how much time to wait
before forcing the shutdown (xm destroy in xen, killing the kvm
-process, for kvm). By default two minutes are given to each
-instance to stop.
+process, for kvm). By default two minutes are given to each instance
+to stop.
+
+The ``--force-multiple`` will skip the interactive confirmation in the
+case the more than one instance will be affected.
-The ``--force-multiple`` will skip the interactive confirmation in
-the case the more than one instance will be affected.
+See **ganeti(7)** for a description of ``--submit`` and other common
+options.
Example::
CONSOLE
^^^^^^^
-**console** [--show-cmd] {*instance*}
+**console** [\--show-cmd] {*instance*}
+
+Connects to the console of the given instance. If the instance is not
+up, an error is returned. Use the ``--show-cmd`` option to display the
+command instead of executing it.
-Connects to the console of the given instance. If the instance is
-not up, an error is returned. Use the ``--show-cmd`` option to
-display the command instead of executing it.
+For HVM instances, this will attempt to connect to the serial console
+of the instance. To connect to the virtualized "physical" console of a
+HVM instance, use a VNC client with the connection info from the
+**info** command.
-For HVM instances, this will attempt to connect to the serial
-console of the instance. To connect to the virtualized "physical"
-console of a HVM instance, use a VNC client with the connection
-info from the **info** command.
+For Xen/kvm instances, if the instance is paused, this attempts to
+unpause the instance after waiting a few seconds for the connection to
+the console to be made.
Example::
REPLACE-DISKS
^^^^^^^^^^^^^
-**replace-disks** [--submit] [--early-release] {-p} [--disks *idx*]
-{*instance*}
+**replace-disks** [\--submit] [\--early-release] [\--ignore-ipolicy] {-p}
+[\--disks *idx*] {*instance*}
-**replace-disks** [--submit] [--early-release] {-s} [--disks *idx*]
-{*instance*}
+**replace-disks** [\--submit] [\--early-release] [\--ignore-ipolicy] {-s}
+[\--disks *idx*] {*instance*}
-**replace-disks** [--submit] [--early-release] {--iallocator *name*
-\| --new-secondary *NODE*} {*instance*}
+**replace-disks** [\--submit] [\--early-release] [\--ignore-ipolicy]
+{{-I\|\--iallocator} *name* \| {{-n|\--new-secondary} *node* } {*instance*}
-**replace-disks** [--submit] [--early-release] {--auto}
-{*instance*}
+**replace-disks** [\--submit] [\--early-release] [\--ignore-ipolicy]
+{-a\|\--auto} {*instance*}
This command is a generalized form for replacing disks. It is
currently only valid for the mirrored (DRBD) disk template.
-The first form (when passing the ``-p`` option) will replace the
-disks on the primary, while the second form (when passing the
-``-s`` option will replace the disks on the secondary node. For
-these two cases (as the node doesn't change), it is possible to
-only run the replace for a subset of the disks, using the option
-``--disks`` which takes a list of comma-delimited disk indices
-(zero-based), e.g. 0,2 to replace only the first and third disks.
+The first form (when passing the ``-p`` option) will replace the disks
+on the primary, while the second form (when passing the ``-s`` option
+will replace the disks on the secondary node. For these two cases (as
+the node doesn't change), it is possible to only run the replace for a
+subset of the disks, using the option ``--disks`` which takes a list
+of comma-delimited disk indices (zero-based), e.g. 0,2 to replace only
+the first and third disks.
The third form (when passing either the ``--iallocator`` or the
``--new-secondary`` option) is designed to change secondary node of
-the instance. Specifying ``--iallocator`` makes the new secondary
-be selected automatically by the specified allocator plugin,
-otherwise the new secondary node will be the one chosen manually
-via the ``--new-secondary`` option.
+the instance. Specifying ``--iallocator`` makes the new secondary be
+selected automatically by the specified allocator plugin, otherwise
+the new secondary node will be the one chosen manually via the
+``--new-secondary`` option.
-The fourth form (when using ``--auto``) will automatically
-determine which disks of an instance are faulty and replace them
-within the same node. The ``--auto`` option works only when an
-instance has only faulty disks on either the primary or secondary
-node; it doesn't work when both sides have faulty disks.
+Note that it is not possible to select an offline or drained node as a
+new secondary.
-The ``--submit`` option is used to send the job to the master
-daemon but not wait for its completion. The job ID will be shown so
-that it can be examined via **gnt-job info**.
+The fourth form (when using ``--auto``) will automatically determine
+which disks of an instance are faulty and replace them within the same
+node. The ``--auto`` option works only when an instance has only
+faulty disks on either the primary or secondary node; it doesn't work
+when both sides have faulty disks.
The ``--early-release`` changes the code so that the old storage on
secondary node(s) is removed early (before the resync is completed)
and the internal Ganeti locks for the current (and new, if any)
secondary node are also released, thus allowing more parallelism in
-the cluster operation. This should be used only when recovering
-from a disk failure on the current secondary (thus the old storage
-is already broken) or when the storage on the primary node is known
-to be fine (thus we won't need the old storage for potential
-recovery).
+the cluster operation. This should be used only when recovering from a
+disk failure on the current secondary (thus the old storage is already
+broken) or when the storage on the primary node is known to be fine
+(thus we won't need the old storage for potential recovery).
-Note that it is not possible to select an offline or drained node
-as a new secondary.
+The ``--ignore-ipolicy`` let the command ignore instance policy
+violations if replace-disks changes groups and the instance would
+violate the new groups instance policy.
+
+See **ganeti(7)** for a description of ``--submit`` and other common
+options.
ACTIVATE-DISKS
^^^^^^^^^^^^^^
-**activate-disks** [--submit] [--ignore-size] {*instance*}
+**activate-disks** [\--submit] [\--ignore-size] {*instance*}
-Activates the block devices of the given instance. If successful,
-the command will show the location and name of the block devices::
+Activates the block devices of the given instance. If successful, the
+command will show the location and name of the block devices::
node1.example.com:disk/0:/dev/drbd0
node1.example.com:disk/1:/dev/drbd1
-In this example, *node1.example.com* is the name of the node on
-which the devices have been activated. The *disk/0* and *disk/1*
-are the Ganeti-names of the instance disks; how they are visible
-inside the instance is hypervisor-specific. */dev/drbd0* and
-*/dev/drbd1* are the actual block devices as visible on the node.
-The ``--submit`` option is used to send the job to the master
-daemon but not wait for its completion. The job ID will be shown so
-that it can be examined via **gnt-job info**.
+In this example, *node1.example.com* is the name of the node on which
+the devices have been activated. The *disk/0* and *disk/1* are the
+Ganeti-names of the instance disks; how they are visible inside the
+instance is hypervisor-specific. */dev/drbd0* and */dev/drbd1* are the
+actual block devices as visible on the node.
The ``--ignore-size`` option can be used to activate disks ignoring
the currently configured size in Ganeti. This can be used in cases
where the configuration has gotten out of sync with the real-world
-(e.g. after a partially-failed grow-disk operation or due to
-rounding in LVM devices). This should not be used in normal cases,
-but only when activate-disks fails without it.
+(e.g. after a partially-failed grow-disk operation or due to rounding
+in LVM devices). This should not be used in normal cases, but only
+when activate-disks fails without it.
+
+Note that it is safe to run this command while the instance is already
+running.
-Note that it is safe to run this command while the instance is
-already running.
+See **ganeti(7)** for a description of ``--submit`` and other common
+options.
DEACTIVATE-DISKS
^^^^^^^^^^^^^^^^
-**deactivate-disks** [-f] [--submit] {*instance*}
+**deactivate-disks** [-f] [\--submit] {*instance*}
-De-activates the block devices of the given instance. Note that if
-you run this command for an instance with a drbd disk template,
-while it is running, it will not be able to shutdown the block
-devices on the primary node, but it will shutdown the block devices
-on the secondary nodes, thus breaking the replication.
+De-activates the block devices of the given instance. Note that if you
+run this command for an instance with a drbd disk template, while it
+is running, it will not be able to shutdown the block devices on the
+primary node, but it will shutdown the block devices on the secondary
+nodes, thus breaking the replication.
The ``-f``/``--force`` option will skip checks that the instance is
down; in case the hypervisor is confused and we can't talk to it,
the disks. This can still fail due to the instance actually running or
other issues.
-The ``--submit`` option is used to send the job to the master
-daemon but not wait for its completion. The job ID will be shown so
-that it can be examined via **gnt-job info**.
+See **ganeti(7)** for a description of ``--submit`` and other common
+options.
GROW-DISK
^^^^^^^^^
-**grow-disk** [--no-wait-for-sync] [--submit] {*instance*} {*disk*}
-{*amount*}
+| **grow-disk** [\--no-wait-for-sync] [\--submit] [\--absolute]
+| {*instance*} {*disk*} {*amount*}
-Grows an instance's disk. This is only possible for instances
-having a plain or drbd disk template.
+Grows an instance's disk. This is only possible for instances having a
+plain, drbd or rbd disk template.
-Note that this command only change the block device size; it will
-not grow the actual filesystems, partitions, etc. that live on that
+Note that this command only change the block device size; it will not
+grow the actual filesystems, partitions, etc. that live on that
disk. Usually, you will need to:
-
-
-
#. use **gnt-instance grow-disk**
#. reboot the instance (later, at a convenient time)
xfs\_growfs(8) to resize the filesystem, or use fdisk(8) to change
the partition table on the disk
-
The *disk* argument is the index of the instance disk to grow. The
-*amount* argument is given either as a number (and it represents
-the amount to increase the disk with in mebibytes) or can be given
-similar to the arguments in the create instance operation, with a
-suffix denoting the unit.
-
-Note that the disk grow operation might complete on one node but
-fail on the other; this will leave the instance with
-different-sized LVs on the two nodes, but this will not create
-problems (except for unused space).
-
-If you do not want gnt-instance to wait for the new disk region to
-be synced, use the ``--no-wait-for-sync`` option.
+*amount* argument is given as a number which can have a suffix (like the
+disk size in instance create); if the suffix is missing, the value will
+be interpreted as mebibytes.
+
+By default, the *amount* value represents the desired increase in the
+disk size (e.g. an amount of 1G will take a disk of size 3G to 4G). If
+the optional ``--absolute`` parameter is passed, then the *amount*
+argument doesn't represent the delta, but instead the desired final disk
+size (e.g. an amount of 8G will take a disk of size 4G to 8G).
+
+For instances with a drbd template, note that the disk grow operation
+might complete on one node but fail on the other; this will leave the
+instance with different-sized LVs on the two nodes, but this will not
+create problems (except for unused space).
+
+If you do not want gnt-instance to wait for the new disk region to be
+synced, use the ``--no-wait-for-sync`` option.
-The ``--submit`` option is used to send the job to the master
-daemon but not wait for its completion. The job ID will be shown so
-that it can be examined via **gnt-job info**.
+See **ganeti(7)** for a description of ``--submit`` and other common
+options.
Example (increase the first disk for instance1 by 16GiB)::
# gnt-instance grow-disk instance1.example.com 0 16g
+Example for increasing the disk size to a certain size::
-Also note that disk shrinking is not supported; use
-**gnt-backup export** and then **gnt-backup import** to reduce the
-disk size of an instance.
+ # gnt-instance grow-disk --absolute instance1.example.com 0 32g
+
+Also note that disk shrinking is not supported; use **gnt-backup
+export** and then **gnt-backup import** to reduce the disk size of an
+instance.
RECREATE-DISKS
^^^^^^^^^^^^^^
-**recreate-disks** [--submit] [--disks=``indices``] {*instance*}
+| **recreate-disks** [\--submit] [-n node1:[node2]]
+| [\--disk=*N*[:[size=*VAL*][,mode=*ro\|rw*]]] {*instance*}
+
+Recreates all or a subset of disks of the given instance.
+
+Note that this functionality should only be used for missing disks; if
+any of the given disks already exists, the operation will fail. While
+this is suboptimal, recreate-disks should hopefully not be needed in
+normal operation and as such the impact of this is low.
-Recreates the disks of the given instance, or only a subset of the
-disks (if the option ``disks`` is passed, which must be a
-comma-separated list of disk indices, starting from zero).
+If only a subset should be recreated, any number of ``disk`` options can
+be specified. It expects a disk index and an optional list of disk
+parameters to change. Only ``size`` and ``mode`` can be changed while
+recreating disks. To recreate all disks while changing parameters on
+a subset only, a ``--disk`` option must be given for every disk of the
+instance.
-Note that this functionality should only be used for missing disks;
-if any of the given disks already exists, the operation will fail.
-While this is suboptimal, recreate-disks should hopefully not be
-needed in normal operation and as such the impact of this is low.
+Optionally the instance's disks can be recreated on different
+nodes. This can be useful if, for example, the original nodes of the
+instance have gone down (and are marked offline), so we can't recreate
+on the same nodes. To do this, pass the new node(s) via ``-n`` option,
+with a syntax similar to the **add** command. The number of nodes
+passed must equal the number of nodes that the instance currently
+has. Note that changing nodes is only allowed when all disks are
+replaced, e.g. when no ``--disk`` option is passed.
-The ``--submit`` option is used to send the job to the master
-daemon but not wait for its completion. The job ID will be shown so
-that it can be examined via **gnt-job info**.
+See **ganeti(7)** for a description of ``--submit`` and other common
+options.
Recovery
~~~~~~~~
FAILOVER
^^^^^^^^
-**failover** [-f] [--ignore-consistency] [--shutdown-timeout=*N*]
-[--submit] {*instance*}
+| **failover** [-f] [\--ignore-consistency] [\--ignore-ipolicy]
+| [\--shutdown-timeout=*N*]
+| [{-n|\--target-node} *node* \| {-I|\--iallocator} *name*]
+| [\--submit]
+| {*instance*}
-Failover will fail the instance over its secondary node. This works
-only for instances having a drbd disk template.
+Failover will stop the instance (if running), change its primary node,
+and if it was originally running it will start it again (on the new
+primary). This only works for instances with drbd template (in which
+case you can only fail to the secondary node) and for externally
+mirrored templates (blockdev and rbd) (which can change to any other
+node).
-Normally the failover will check the consistency of the disks
-before failing over the instance. If you are trying to migrate
-instances off a dead node, this will fail. Use the
-``--ignore-consistency`` option for this purpose. Note that this
-option can be dangerous as errors in shutting down the instance
-will be ignored, resulting in possibly having the instance running
-on two machines in parallel (on disconnected DRBD drives).
+If the instance's disk template is of type blockdev or rbd, then you
+can explicitly specify the target node (which can be any node) using
+the ``-n`` or ``--target-node`` option, or specify an iallocator plugin
+using the ``-I`` or ``--iallocator`` option. If you omit both, the default
+iallocator will be used to specify the target node.
+
+Normally the failover will check the consistency of the disks before
+failing over the instance. If you are trying to migrate instances off
+a dead node, this will fail. Use the ``--ignore-consistency`` option
+for this purpose. Note that this option can be dangerous as errors in
+shutting down the instance will be ignored, resulting in possibly
+having the instance running on two machines in parallel (on
+disconnected DRBD drives).
The ``--shutdown-timeout`` is used to specify how much time to wait
before forcing the shutdown (xm destroy in xen, killing the kvm
-process, for kvm). By default two minutes are given to each
-instance to stop.
+process, for kvm). By default two minutes are given to each instance
+to stop.
+
+If ``--ignore-ipolicy`` is given any instance policy violations occuring
+during this operation are ignored.
-The ``--submit`` option is used to send the job to the master
-daemon but not wait for its completion. The job ID will be shown so
-that it can be examined via **gnt-job info**.
+See **ganeti(7)** for a description of ``--submit`` and other common
+options.
Example::
MIGRATE
^^^^^^^
-**migrate** [-f] {--cleanup} {*instance*}
+| **migrate** [-f] [\--allow-failover] [\--non-live]
+| [\--migration-mode=live\|non-live] [\--ignore-ipolicy]
+| [\--no-runtime-changes] [\--submit]
+| [{-n|\--target-node} *node* \| {-I|\--iallocator} *name*] {*instance*}
-**migrate** [-f] [--non-live] [--migration-mode=live\|non-live]
-{*instance*}
+| **migrate** [-f] \--cleanup [\--submit] {*instance*}
-Migrate will move the instance to its secondary node without
-shutdown. It only works for instances having the drbd8 disk
-template type.
+Migrate will move the instance to its secondary node without shutdown.
+As with failover, it only works for instances having the drbd disk
+template or an externally mirrored disk template type such as blockdev
+or rbd.
-The migration command needs a perfectly healthy instance, as we
-rely on the dual-master capability of drbd8 and the disks of the
-instance are not allowed to be degraded.
+If the instance's disk template is of type blockdev or rbd, then you can
+explicitly specify the target node (which can be any node) using the
+``-n`` or ``--target-node`` option, or specify an iallocator plugin
+using the ``-I`` or ``--iallocator`` option. If you omit both, the
+default iallocator will be used to specify the target node.
+
+The migration command needs a perfectly healthy instance, as we rely
+on the dual-master capability of drbd8 and the disks of the instance
+are not allowed to be degraded.
The ``--non-live`` and ``--migration-mode=non-live`` options will
switch (for the hypervisors that support it) between a "fully live"
-(i.e. the interruption is as minimal as possible) migration and one
-in which the instance is frozen, its state saved and transported to
-the remote node, and then resumed there. This all depends on the
-hypervisor support for two different methods. In any case, it is
-not an error to pass this parameter (it will just be ignored if the
-hypervisor doesn't support it). The option
-``--migration-mode=live`` option will request a fully-live
-migration. The default, when neither option is passed, depends on
-the hypervisor parameters (and can be viewed with the
-**gnt-cluster info** command).
+(i.e. the interruption is as minimal as possible) migration and one in
+which the instance is frozen, its state saved and transported to the
+remote node, and then resumed there. This all depends on the
+hypervisor support for two different methods. In any case, it is not
+an error to pass this parameter (it will just be ignored if the
+hypervisor doesn't support it). The option ``--migration-mode=live``
+option will request a fully-live migration. The default, when neither
+option is passed, depends on the hypervisor parameters (and can be
+viewed with the **gnt-cluster info** command).
If the ``--cleanup`` option is passed, the operation changes from
-migration to attempting recovery from a failed previous migration.
-In this mode, Ganeti checks if the instance runs on the correct
-node (and updates its configuration if not) and ensures the
-instances's disks are configured correctly. In this mode, the
-``--non-live`` option is ignored.
+migration to attempting recovery from a failed previous migration. In
+this mode, Ganeti checks if the instance runs on the correct node (and
+updates its configuration if not) and ensures the instances' disks
+are configured correctly. In this mode, the ``--non-live`` option is
+ignored.
The option ``-f`` will skip the prompting for confirmation.
+If ``--allow-failover`` is specified it tries to fallback to failover if
+it already can determine that a migration won't work (e.g. if the
+instance is shut down). Please note that the fallback will not happen
+during execution. If a migration fails during execution it still fails.
+
+If ``--ignore-ipolicy`` is given any instance policy violations occuring
+during this operation are ignored.
+
+The ``--no-runtime-changes`` option forbids migrate to alter an
+instance's runtime before migrating it (eg. ballooning an instance
+down because the target node doesn't have enough available memory).
+
+If an instance has the backend parameter ``always\_failover`` set to
+true, then the migration is automatically converted into a failover.
+
+See **ganeti(7)** for a description of ``--submit`` and other common
+options.
+
Example (and expected output)::
# gnt-instance migrate instance1
- Migrate will happen to the instance instance1. Note that migration is
- **experimental** in this version. This might impact the instance if
- anything goes wrong. Continue?
+ Instance instance1 will be migrated. Note that migration
+ might impact the instance if anything goes wrong (e.g. due to bugs in
+ the hypervisor). Continue?
y/[n]/?: y
+ Migrating instance instance1.example.com
* checking disk consistency between source and target
- * ensuring the target is in secondary mode
+ * switching node node2.example.com to secondary mode
+ * changing into standalone mode
* changing disks into dual-master mode
- - INFO: Waiting for instance instance1 to sync disks.
- - INFO: Instance instance1's disks are in sync.
+ * wait until resync is done
+ * preparing node2.example.com to accept the instance
* migrating instance to node2.example.com
- * changing the instance's disks on source node to secondary
- - INFO: Waiting for instance instance1 to sync disks.
- - INFO: Instance instance1's disks are in sync.
- * changing the instance's disks to single-master
+ * switching node node1.example.com to secondary mode
+ * wait until resync is done
+ * changing into standalone mode
+ * changing disks into single-master mode
+ * wait until resync is done
+ * done
#
MOVE
^^^^
-**move** [-f] [-n *node*] [--shutdown-timeout=*N*] [--submit]
-{*instance*}
+| **move** [-f] [\--ignore-consistency]
+| [-n *node*] [\--shutdown-timeout=*N*] [\--submit] [\--ignore-ipolicy]
+| {*instance*}
-Move will move the instance to an arbitrary node in the cluster.
-This works only for instances having a plain or file disk
-template.
+Move will move the instance to an arbitrary node in the cluster. This
+works only for instances having a plain or file disk template.
-Note that since this operation is done via data copy, it will take
-a long time for big disks (similar to replace-disks for a drbd
+Note that since this operation is done via data copy, it will take a
+long time for big disks (similar to replace-disks for a drbd
instance).
The ``--shutdown-timeout`` is used to specify how much time to wait
kvm process for KVM, etc.). By default two minutes are given to each
instance to stop.
-The ``--submit`` option is used to send the job to the master
-daemon but not wait for its completion. The job ID will be shown so
-that it can be examined via **gnt-job info**.
+The ``--ignore-consistency`` option will make Ganeti ignore any errors
+in trying to shutdown the instance on its node; useful if the
+hypervisor is broken and you want to recuperate the data.
+
+If ``--ignore-ipolicy`` is given any instance policy violations occuring
+during this operation are ignored.
+
+See **ganeti(7)** for a description of ``--submit`` and other common
+options.
Example::
# gnt-instance move -n node3.example.com instance1.example.com
+CHANGE-GROUP
+~~~~~~~~~~~~
+
+| **change-group** [\--submit]
+| [\--iallocator *NAME*] [\--to *GROUP*...] {*instance*}
+
+This command moves an instance to another node group. The move is
+calculated by an iallocator, either given on the command line or as a
+cluster default.
+
+If no specific destination groups are specified using ``--to``, all
+groups except the one containing the instance are considered.
+
+See **ganeti(7)** for a description of ``--submit`` and other common
+options.
+
+Example::
+
+ # gnt-instance change-group -I hail --to rack2 inst1.example.com
+
+
TAGS
~~~~
ADD-TAGS
^^^^^^^^
-**add-tags** [--from *file*] {*instancename*} {*tag*...}
+**add-tags** [\--from *file*] {*instancename*} {*tag*...}
Add tags to the given instance. If any of the tags contains invalid
characters, the entire operation will abort.
-If the ``--from`` option is given, the list of tags will be
-extended with the contents of that file (each line becomes a tag).
-In this case, there is not need to pass tags on the command line
-(if you do, both sources will be used). A file name of ``-`` will be
-interpreted as stdin.
+If the ``--from`` option is given, the list of tags will be extended
+with the contents of that file (each line becomes a tag). In this
+case, there is not need to pass tags on the command line (if you do,
+both sources will be used). A file name of ``-`` will be interpreted
+as stdin.
LIST-TAGS
^^^^^^^^^
REMOVE-TAGS
^^^^^^^^^^^
-**remove-tags** [--from *file*] {*instancename*} {*tag*...}
+**remove-tags** [\--from *file*] {*instancename*} {*tag*...}
Remove tags from the given instance. If any of the tags are not
existing on the node, the entire operation will abort.
In this case, there is not need to pass tags on the command line (if
you do, tags from both sources will be removed). A file name of ``-``
will be interpreted as stdin.
+
+.. vim: set textwidth=72 :
+.. Local Variables:
+.. mode: rst
+.. fill-column: 72
+.. End:
projects / ganeti-local / blobdiff