| **add**
| {-t|\--disk-template {diskless | file \| plain \| drbd \| rbd}}
-| {\--disk=*N*: {size=*VAL* \| adopt=*LV*}[,vg=*VG*][,metavg=*VG*][,mode=*ro\|rw*]
+| {\--disk=*N*: {size=*VAL* \| adopt=*LV*}[,options...]
+| \| {size=*VAL*,provider=*PROVIDER*}[,param=*value*... ][,options...]
| \| {-s|\--os-size} *SIZE*}
| [\--no-ip-check] [\--no-name-check] [\--no-start] [\--no-install]
| [\--net=*N* [:options...] \| \--no-nics]
The ``disk`` option specifies the parameters for the disks of the
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 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.
+source needs to be given. 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. Each disk can also take these
+parameters (all optional):
+
+mode
+ The access mode. Either ``ro`` (read-only) or the default ``rw``
+ (read-write).
+
+name
+ this option specifies a name for the disk, which can be used as a disk
+ identifier. An instance can not have two disks with the same name.
+
+vg
+ The LVM volume group. This works only for LVM and DRBD devices.
+
+metavg
+ This options specifies a different VG for the metadata device. This
+ works only for DRBD devices
+
+When creating ExtStorage disks, also arbitrary parameters can be passed,
+to the ExtStorage provider. Those parameters are passed as additional
+comma separated options. Therefore, an ExtStorage disk provided by
+provider ``pvdr1`` with parameters ``param1``, ``param2`` would be
+passed as ``--disk 0:size=10G,provider=pvdr1,param1=val1,param2=val2``.
When using the ``adopt`` key in the disk definition, Ganeti will
reuse those volumes (instead of creating new ones) as the
can be specified as ``--disk 0:size=20G --disk 1:size=4G --disk
2:size=100G``.
+The minimum information needed to specify an ExtStorage disk are the
+``size`` and the ``provider``. For example:
+``--disk 0:size=20G,provider=pvdr1``.
+
The ``--no-ip-check`` skips the checks that are done to see if the
instance's IP is not already alive (i.e. reachable from the master
node).
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.
The NICs of the instances can be specified via the ``--net``
option. By default, one NIC is created for the instance, with a
-random MAC, and set up according the the cluster level nic
+random MAC, and set up according the the cluster level NIC
parameters. Each NIC can take these parameters (all optional):
mac
the node expects the instance to use)
mode
- specifies the connection mode for this nic: routed or bridged.
+ specifies the connection mode for this NIC: routed, bridged or
+ openvswitch.
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)
-
-
-Of these "mode" and "link" are nic parameters, and inherit their
+ in bridged or openvswitch mode specifies the interface 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). Note that openvswitch support is also hypervisor
+ dependent.
+
+network
+ derives the mode and the link from the settings of the network
+ which is identified by its name. If the network option is chosen,
+ link and mode must not be specified. Note that the mode and link
+ depend on the network-to-nodegroup connection, thus allowing
+ different nodegroups to be connected to the same network in
+ different ways.
+
+name
+ this option specifies a name for the NIC, which can be used as a NIC
+ identifier. An instance can not have two NICs with the same name.
+
+
+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.
This parameter determines the way the cdroms disks are presented
to the instance. The default behavior is to get the same value of
- the eariler parameter (disk_type). The possible options are:
+ the earlier parameter (disk_type). The possible options are:
- paravirtual
- ide
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).
+ for TLS connections. For the format, see man **cipher**\(1).
spice\_use\_vdagent
Valid for the KVM hypervisor.
Valid for the KVM hypervisor.
This boolean option specifies whether to emulate a serial console
- for the instance.
+ for the instance. Note that some versions of KVM have a bug that
+ will make an instance hang when configured to use the serial console
+ unless a connection is made to it within about 2 seconds of the
+ instance's startup. For such case it's recommended to disable this
+ option, which is enabled by default.
+
+serial\_speed
+ Valid for the KVM hypervisor.
+
+ This integer option specifies the speed of the serial console.
+ Common values are 9600, 19200, 38400, 57600 and 115200: choose the
+ one which works on your system. (The default is 38400 for historical
+ reasons, but newer versions of kvm/qemu work with 115200)
disk\_cache
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
the colon-separated list _must_ equal the number of VCPUs of the
instance.
- Example::
+ Example:
+
+ .. code-block:: bash
# Map the entire instance to CPUs 0-2
gnt-instance modify -H cpu_mask=0-2 my-inst
# Turn off CPU pinning (default setting)
gnt-instance modify -H cpu_mask=all my-inst
+cpu\_cap
+ Valid for the Xen hypervisor.
+
+ Set the maximum amount of cpu usage by the VM. The value is a percentage
+ between 0 and (100 * number of VCPUs). Default cap is 0: unlimited.
+
+cpu\_weight
+ Valid for the Xen hypervisor.
+
+ Set the cpu time ratio to be allocated to the VM. Valid values are
+ between 1 and 65535. Default weight is 256.
+
usb\_mouse
Valid for the KVM hypervisor.
It is set to ``reboot`` by default.
+cpu\_cores
+ Valid for the KVM hypervisor.
+
+ Number of emulated CPU cores.
+
+cpu\_threads
+ Valid for the KVM hypervisor.
+
+ Number of emulated CPU threads.
+
+cpu\_sockets
+ Valid for the KVM hypervisor.
+
+ Number of emulated CPU sockets.
+
+soundhw
+ Valid for the KVM hypervisor.
+
+ Comma separated list of emulated sounds cards, or "all" to enable
+ all the available ones.
+
+usb\_devices
+ Valid for the KVM hypervisor.
+
+ Comma separated list of usb devices. These can be emulated devices
+ or passthrough ones, and each one gets passed to kvm with its own
+ ``-usbdevice`` option. See the **qemu**\(1) manpage for the syntax
+ of the possible components.
+
+vga
+ Valid for the KVM hypervisor.
+
+ Emulated vga mode, passed the the kvm -vga option.
+
+kvm\_extra
+ Valid for the KVM hypervisor.
+
+ Any other option to the KVM hypervisor, useful tweaking anything
+ that Ganeti doesn't support.
+
+machine\_version
+ Valid for the KVM hypervisor.
+
+ Use in case an instance must be booted with an exact type of
+ machine version (due to e.g. outdated drivers). In case it's not set
+ the default version supported by your version of kvm is used.
+
+kvm\_path
+ Valid for the KVM hypervisor.
+
+ Path to the userspace KVM (or qemu) program.
The ``-O (--os-parameters)`` option allows customisation of the OS
parameters. The actual parameter names and values depends on the OS
gnt-instance add -O dhcp=yes ...
-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 ``-I (--iallocator)`` option specifies the instance allocator plugin
+to use (``.`` means the default allocator). 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 (--disk-template)`` options specifies the disk layout type
for the instance. The available choices are:
file
Disk devices will be regular files.
+sharedfile
+ Disk devices will be regulare files on a shared directory.
+
plain
Disk devices will be logical volumes.
rbd
Disk devices will be rbd volumes residing inside a RADOS cluster.
+blockdev
+ Disk devices will be adopted pre-existent block devices.
+
+ext
+ Disk devices will be provided by external shared storage,
+ through the ExtStorage Interface using ExtStorage providers.
The optional second value of the ``-n (--node)`` is used for the drbd
template type and specifies the remote node.
instances. The full path of the directory where the disk files are
stored will consist of cluster-wide file storage directory + optional
subdirectory + instance name. Example:
-``@RPL_FILE_STORAGE_DIR@``*/mysubdir/instance1.example.com*. This
+``@RPL_FILE_STORAGE_DIR@/mysubdir/instance1.example.com``. This
option is only relevant for instances using the file storage backend.
The ``--file-driver`` specifies the driver to use for file-based
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
+See **ganeti**\(7) for a description of ``--submit`` and other common
options.
Example::
-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
+ # gnt-instance add -t rbd --disk 0:size=30g -B maxmem=512 -o debian-etch \
+ -n node1.example.com instance1.example.com
+ # gnt-instance add -t ext --disk 0:size=30g,provider=pvdr1 -B maxmem=512 \
+ -o debian-etch -n node1.example.com instance1.example.com
+ # gnt-instance add -t ext --disk 0:size=30g,provider=pvdr1,param1=val1 \
+ --disk 1:size=40g,provider=pvdr2,param2=val2,param3=val3 -B maxmem=512 \
+ -o debian-etch -n node1.example.com instance1.example.com
BATCH-CREATE
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
- List of nics that will be created for the instance. Each entry
+ List of NICs that will be created for the instance. Each entry
should be a dict, with mac, ip, mode and link as possible keys.
Please don't provide the "mac, ip, mode, link" parent keys if you
- use this method for specifying nics.
+ use this method for specifying NICs.
primary\_node, secondary\_node
The primary and optionally the secondary node to use for the
The ``--force`` option is used to skip the interactive confirmation.
-See **ganeti(7)** for a description of ``--submit`` and other common
+See **ganeti**\(7) for a description of ``--submit`` and other common
options.
Example::
a given output unit.
The ``-v`` option activates verbose mode, which changes the display of
-special field states (see **ganeti(7)**).
+special field states (see **ganeti**\(7)).
The ``-o (--output)`` option takes a comma-separated list of output
fields. The available fields and their meaning are:
output fields.
If exactly one argument is given and it appears to be a query filter
-(see **ganeti(7)**), the query result is filtered accordingly. For
+(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``).
LIST-FIELDS
-~~~~~~~~~~~
+^^^^^^^^^^^
**list-fields** [field...]
| [{-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*]
+| [\--net add[:options...] \|
+| \--net [*N*:]add[,options...] \|
+| \--net [*ID*:]remove \|
+| \--net *ID*:modify[,options...]]
+| [\--disk add:size=*SIZE*[,options...] \|
+| \--disk *N*:add,size=*SIZE*[,options...] \|
+| \--disk *N*:add,size=*SIZE*,provider=*PROVIDER*[,options...][,param=*value*... ] \|
+| \--disk *ID*:modify[,options...]
+| \--disk [*ID*:]remove]
| [{-t|\--disk-template} plain | {-t|\--disk-template} drbd -n *new_secondary*] [\--no-wait-for-sync]
+| [\--new-primary=*node*]
| [\--os-type=*OS* [\--force-variant]]
| [{-O|\--os-parameters} *param*=*value*... ]
| [\--offline \| \--online]
| {*instance*}
Modifies the memory size, number of vcpus, ip address, MAC address
-and/or nic parameters for an instance. It can also add and remove
+and/or NIC parameters for an instance. It can also add and remove
disks and NICs to/from the instance. Note that you need to give at
least one of the arguments, otherwise the command complains.
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 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* 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 ``--disk add:size=*SIZE*,[options..]`` option adds a disk to the
+instance, and ``--disk *N*:add:size=*SIZE*,[options..]`` will add a disk
+to the the instance at a specific index. The available options are the
+same as in the **add** command(``mode``, ``name``, ``vg``, ``metavg``).
+When adding an ExtStorage disk the ``provider=*PROVIDER*`` option is
+also mandatory and specifies the ExtStorage provider. Also, for
+ExtStorage disks arbitrary parameters can be passed as additional comma
+separated options, same as in the **add** command. -The ``--disk remove``
+option will remove the last disk of the instance. Use
+``--disk `` *ID*``:remove`` to remove a disk by its identifier. *ID*
+can be the index of the disk, the disks's name or the disks's UUID. The
+``--disk *ID*:modify[,options...]`` wil change the options of the disk.
+Available options are:
+
+mode
+ The access mode. Either ``ro`` (read-only) or the default ``rw`` (read-write).
+
+name
+ this option specifies a name for the disk, which can be used as a disk
+ identifier. An instance can not have two disks with the same name.
+
+The ``--net *N*:add[,options..]`` will add a new network interface to
+the instance. The available options are the same as in the **add**
+command (``mac``, ``ip``, ``link``, ``mode``, ``network``). The
+``--net *ID*,remove`` will remove the intances' NIC with *ID* identifier,
+which can be the index of the NIC, the NIC's name or the NIC's UUID.
+The ``--net *ID*:modify[,options..]`` option will change the parameters of
+the instance network interface with the *ID* identifier.
The option ``-o (--os-type)`` will change the OS name for the instance
(without reinstallation). In case an OS variant is specified that is
``--force-variant`` is passed. An invalid OS will also be refused,
unless the ``--force`` option is given.
+The option ``--new-primary`` will set the new primary node of an instance
+assuming the disks have already been moved manually. Unless the ``--force``
+option is given, it is verified that the instance is no longer running
+on its current primary node.
+
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
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
+See **ganeti**\(7) for a description of ``--submit`` and other common
options.
Most of the changes take effect at the next restart. If the instance is
or ``--all`` options), the user must pass the ``--force-multiple``
options to skip the interactive confirmation.
-See **ganeti(7)** for a description of ``--submit`` and other common
+See **ganeti**\(7) for a description of ``--submit`` and other common
options.
RENAME
the next time the instance is started). The IP test can be skipped if
the ``--no-ip-check`` option is passed.
+Note that you can rename an instance to its same name, to force
+re-executing the os-specific rename script for that instance, if
+needed.
+
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.
-See **ganeti(7)** for a description of ``--submit`` and other common
+See **ganeti**\(7) for a description of ``--submit`` and other common
options.
Starting/stopping/connecting to console
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
+before, Ganeti will still think 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.
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
+See **ganeti**\(7) for a description of ``--submit`` and other common
options.
Example::
| **shutdown**
| [\--timeout=*N*]
-| [\--force-multiple] [\--ignore-offline] [\--no-remember]
+| [\--force] [\--force-multiple] [\--ignore-offline] [\--no-remember]
| [\--instance \| \--node \| \--primary \| \--secondary \| \--all \|
| \--tags \| \--node-tags \| \--pri-node-tags \| \--sec-node-tags]
| [\--submit]
force the instance to be marked as stopped. This option should be used
with care as it can lead to an inconsistent cluster state.
+Use ``--force`` to be able to shutdown an instance even when it's marked
+as offline. This is useful is an offline instance ends up in the
+``ERROR_up`` state, for example.
+
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
``--no-remember``, and when the watcher is activated again it will
restore the correct runtime state for all instances.
-See **ganeti(7)** for a description of ``--submit`` and other common
+See **ganeti**\(7) for a description of ``--submit`` and other common
options.
Example::
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
+See **ganeti**\(7) for a description of ``--submit`` and other common
options.
Example::
[\--disks *idx*] {*instance*}
**replace-disks** [\--submit] [\--early-release] [\--ignore-ipolicy]
-{{-I\|\--iallocator} *name* \| \--node *node* } {*instance*}
+{{-I\|\--iallocator} *name* \| {{-n|\--new-secondary} *node* } {*instance*}
**replace-disks** [\--submit] [\--early-release] [\--ignore-ipolicy]
-{\--auto} {*instance*}
+{-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 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.
+``--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 (use ``.`` to
+indicate the default allocator), otherwise the new secondary node will
+be the one chosen manually via the ``--new-secondary`` option.
Note that it is not possible to select an offline or drained node as a
new secondary.
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
+See **ganeti**\(7) for a description of ``--submit`` and other common
options.
ACTIVATE-DISKS
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
+See **ganeti**\(7) for a description of ``--submit`` and other common
options.
DEACTIVATE-DISKS
the disks. This can still fail due to the instance actually running or
other issues.
-See **ganeti(7)** for a description of ``--submit`` and other common
+See **ganeti**\(7) for a description of ``--submit`` and other common
options.
GROW-DISK
| {*instance*} {*disk*} {*amount*}
Grows an instance's disk. This is only possible for instances having a
-plain, drbd or rbd disk template.
+plain, drbd, file, sharedfile, rbd or ext disk template. For the ext
+template to work, the ExtStorage provider should also support growing.
+This means having a ``grow`` script that actually grows the volume of
+the external shared storage.
Note that this command only change the block device size; it will not
grow the actual filesystems, partitions, etc. that live on that
#. reboot the instance (later, at a convenient time)
-#. use a filesystem resizer, such as ext2online(8) or
- xfs\_growfs(8) to resize the filesystem, or use fdisk(8) to change
- the partition table on the disk
+#. use a filesystem resizer, such as **ext2online**\(8) or
+ **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 as a number which can have a suffix (like the
If you do not want gnt-instance to wait for the new disk region to be
synced, use the ``--no-wait-for-sync`` option.
-See **ganeti(7)** for a description of ``--submit`` and other common
+See **ganeti**\(7) for a description of ``--submit`` and other common
options.
Example (increase the first disk for instance1 by 16GiB)::
has. Note that changing nodes is only allowed when all disks are
replaced, e.g. when no ``--disk`` option is passed.
-Another method of chosing which nodes to place the instance on is by
+Another method of choosing which nodes to place the instance on is by
using the specified iallocator, passing the ``--iallocator`` option.
The primary and secondary nodes will be chosen by the specified
-iallocator plugin.
+iallocator plugin, or by the default allocator if ``.`` is specified.
-See **ganeti(7)** for a description of ``--submit`` and other common
+See **ganeti**\(7) for a description of ``--submit`` and other common
options.
-Recovery
-~~~~~~~~
+Recovery/moving
+~~~~~~~~~~~~~~~
FAILOVER
^^^^^^^^
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).
-
-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.
+primary). This works for instances with drbd template (in which case you
+can only fail to the secondary node) and for externally mirrored
+templates (sharedfile, blockdev, rbd and ext) (in which case you can
+fail to any other node).
+
+If the instance's disk template is of type sharedfile, blockdev, rbd or
+ext, 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.
+
+If the instance's disk template is of type drbd, the target node is
+automatically selected as the drbd's secondary node. Changing the
+secondary node is possible with a replace-disks operation.
Normally the failover will check the consistency of the disks before
failing over the instance. If you are trying to migrate instances off
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
+See **ganeti**\(7) for a description of ``--submit`` and other common
options.
Example::
# gnt-instance failover instance1.example.com
+For externally mirrored templates also ``-n`` is available::
+
+ # gnt-instance failover -n node3.example.com instance1.example.com
+
MIGRATE
^^^^^^^
| **migrate** [-f] \--cleanup [\--submit] {*instance*}
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.
-
-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.
+As with failover, it works for instances having the drbd disk template
+or an externally mirrored disk template type such as sharedfile,
+blockdev, rbd or ext.
+
+If the instance's disk template is of type sharedfile, blockdev, rbd or
+ext, 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. Alternatively, the default iallocator can be requested by
+specifying ``.`` as the name of the plugin.
+
+If the instance's disk template is of type drbd, the target node is
+automatically selected as the drbd's secondary node. Changing the
+secondary node is possible with a replace-disks operation.
+
+The migration command needs a perfectly healthy instance for drbd
+instances, 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"
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
+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
+updates its configuration if not) and ensures the instances' disks
are configured correctly. In this mode, the ``--non-live`` option is
ignored.
instance's runtime before migrating it (eg. ballooning an instance
down because the target node doesn't have enough available memory).
-See **ganeti(7)** for a description of ``--submit`` and other common
+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)::
| [-n *node*] [\--shutdown-timeout=*N*] [\--submit] [\--ignore-ipolicy]
| {*instance*}
-Move will move the instance to an arbitrary node in the cluster. This
+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
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.
+hypervisor is broken and you want to recover 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
+See **ganeti**\(7) for a description of ``--submit`` and other common
options.
Example::
CHANGE-GROUP
-~~~~~~~~~~~~
+^^^^^^^^^^^^
| **change-group** [\--submit]
| [\--iallocator *NAME*] [\--to *GROUP*...] {*instance*}
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
+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
+Tags
~~~~
ADD-TAGS
projects / ganeti-local / blobdiff