| **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]
+| [\--no-ip-check] [\--no-name-check] [\--no-conflicts-check]
+| [\--no-start] [\--no-install]
| [\--net=*N* [:options...] \| \--no-nics]
| [{-B|\--backend-parameters} *BEPARAMS*]
| [{-H|\--hypervisor-parameters} *HYPERVISOR* [: option=*value*... ]]
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).
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
ip
specifies the IP address assigned to the instance from the Ganeti
side (this is not necessarily what the instance will use, but what
- the node expects the instance to use)
+ the node expects the instance to use). Note that if an IP in the
+ range of a network configured with **gnt-network**\(8) is used,
+ and the NIC is not already connected to it, this network has to be
+ passed in the **network** parameter if this NIC is meant to be
+ connected to the said network. ``--no-conflicts-check`` can be used
+ to override this check. The special value **pool** causes Ganeti to
+ select an IP from the the network the NIC is or will be connected to.
+ One can pick an externally reserved IP of a network along with
+ ``--no-conflict-check``. Note that this IP cannot be assigned to
+ any other instance until it gets released.
mode
- specifies the connection mode for this nic: routed, bridged or
+ specifies the connection mode for this NIC: routed, bridged or
openvswitch.
link
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
+
+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.
- e1000 (KVM)
- paravirtual (default for KVM) (HVM & KVM)
+vif\_type
+ Valid for the Xen HVM hypervisor.
+
+ This parameter specifies the vif type of the nic configuration
+ of the instance. Unsetting the value leads to no type being specified
+ in the configuration. Note that this parameter only takes effect when
+ the 'nic_type' is not set. The possible options are:
+
+ - ioemu
+ - vif
+
disk\_type
Valid for the Xen HVM and KVM hypervisors.
pae
Valid for the Xen HVM and KVM hypervisors.
- A boolean option that specifies if the hypervisor should enabled
+ A boolean option that specifies if the hypervisor should enable
PAE support for this instance. The default is false, disabling PAE
support.
+viridian
+ Valid for the Xen HVM hypervisor.
+
+ A boolean option that specifies if the hypervisor should enable
+ viridian (Hyper-V) for this instance. The default is false,
+ disabling viridian support.
+
use\_localtime
Valid for the Xen HVM and KVM hypervisors.
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.
``-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.
+ that Ganeti doesn't support. Note that values set with this
+ parameter are split on a space character and currently don't support
+ quoting.
+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.
+
+vnet\_hdr
+ Valid for the KVM hypervisor.
+
+ This boolean option determines whether the tap devices used by the
+ KVM paravirtual nics (virtio-net) will get created with VNET_HDR
+ (IFF_VNET_HDR) support.
+
+ If set to false, it effectively disables offloading on the virio-net
+ interfaces, which prevents host kernel tainting and log flooding,
+ when dealing with broken or malicious virtio-net drivers.
+
+ It is set to ``true`` by default.
The ``-O (--os-parameters)`` option allows customisation of the OS
parameters. The actual parameter names and values depends on the OS
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.
-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
^^^^^^^^^^^^
-**batch-create** {instances\_file.json}
+| **batch-create**
+| [{-I|\--iallocator} *instance allocator*]
+| {instances\_file.json}
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.
+multiple instance creation jobs based on a definition file. This
+file can contain all options which are valid when adding an instance
+with the exception of the ``iallocator`` field. The IAllocator is,
+for optimization purposes, only allowed to be set for the whole batch
+operation using the ``--iallocator`` parameter.
-The instance file should be a valid-formed JSON file, containing a
-dictionary with instance name and instance parameters. The accepted
-parameters are:
+The instance file must be a valid-formed JSON file, containing an
+array of dictionaries with instance creation parameters. All parameters
+(except ``iallocator``) which are valid for the instance creation
+OP code are allowed. The most important ones are:
-disk\_size
- The size of the disks of the instance.
+instance\_name
+ The FQDN of the new instance.
disk\_template
The disk template to use for the instance, the same as in the
**add** command.
-backend
+disks
+ Array of disk specifications. Each entry describes one disk as a
+ dictionary of disk parameters.
+
+beparams
A dictionary of backend parameters.
hypervisor
- A dictionary with a single key (the hypervisor name), and as value
- the hypervisor options. If not passed, the default hypervisor and
- hypervisor options will be inherited.
+ The hypervisor for 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 compatible
- key.
+hvparams
+ A dictionary with the hypervisor options. If not passed, the default
+ hypervisor options will be inherited.
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
+pnode, snode
The primary and optionally the secondary node to use for the
- instance (in case an iallocator script is not used).
-
-iallocator
- Instead of specifying the nodes, an iallocator script can be used
- to automatically compute them.
+ instance (in case an iallocator script is not used). If those
+ parameters are given, they have to be given consistently for all
+ instances in the batch operation.
start
whether to start the instance
A simple definition for one instance can be (with most of the
parameters taken from the cluster defaults)::
- {
- "instance3": {
- "template": "drbd",
- "os": "debootstrap",
- "disk_size": ["25G"],
- "iallocator": "dumb"
+ [
+ {
+ "mode": "create",
+ "instance_name": "instance1.example.com",
+ "disk_template": "drbd",
+ "os_type": "debootstrap",
+ "disks": [{"size":"1024"}],
+ "nics": [{}],
+ "hypervisor": "xen-pvm"
},
- "instance5": {
- "template": "drbd",
- "os": "debootstrap",
- "disk_size": ["25G"],
- "iallocator": "dumb",
+ {
+ "mode": "create",
+ "instance_name": "instance2.example.com",
+ "disk_template": "drbd",
+ "os_type": "debootstrap",
+ "disks": [{"size":"4096", "mode": "rw", "vg": "xenvg"}],
+ "nics": [{}],
"hypervisor": "xen-hvm",
"hvparams": {"acpi": true},
- "backend": {"maxmem": 512, "minmem": 256}
+ "beparams": {"maxmem": 512, "minmem": 256}
}
- }
+ ]
The command will display the job id for each submitted instance, as
follows::
# gnt-instance batch-create instances.json
- instance3: 11224
- instance5: 11225
+ Submitted jobs 37, 38
REMOVE
^^^^^^
| [{-H|\--hypervisor-parameters} *HYPERVISOR\_PARAMETERS*]
| [{-B|\--backend-parameters} *BACKEND\_PARAMETERS*]
| [{-m|\--runtime-memory} *SIZE*]
-| [\--net add*[:options]* \| \--net [*N*:]remove \| \--net *N:options*]
-| [\--disk add:size=*SIZE*[,vg=*VG*][,metavg=*VG*] \| \--disk [*N*:]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]
| [\--submit]
| [\--ignore-ipolicy]
+| [\--hotplug]
+| [\--hotplug-if-possible]
| {*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.
+If ``--hotplug`` is given any disk and nic modifications will take
+effect without the need of actual reboot. Please note that this feature
+is currently supported only for KVM hypervisor and for versions greater
+than 1.0.
+
+If ``--hotplug-if-possible`` is given then ganeti won't abort in case
+hotplug is not supported. It will continue execution and modification
+will take place after reboot. This covers use cases where instances are
+not running or hypervisor is not KVM.
+
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
running, there is no effect on the instance.
+
+SNAPSHOT
+^^^^^^^^
+
+| **snapshot**
+| {\--disk=*ID*:snapshot_name=*VAL*
+| [\--submit]
+| {*instance*}
+
+This only works for instances with ext disk template. It eventualla runs
+the snapshot script of the corresponding extstorage provider.
+The ``--disk 0:snapshot_name=snap1`` will take snapshot of the first disk
+by exporting snapshot name (via VOL_SNAPSHOT_NAME) and disk related info
+to the script environment. *ID* can be a disk index, name or UUID.
+
+
REINSTALL
^^^^^^^^^
| {*instance*} {*disk*} {*amount*}
Grows an instance's disk. This is only possible for instances having a
-plain, drbd, file, sharedfile 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
| **failover** [-f] [\--ignore-consistency] [\--ignore-ipolicy]
| [\--shutdown-timeout=*N*]
| [{-n|\--target-node} *node* \| {-I|\--iallocator} *name*]
-| [\--submit]
+| [\--submit] [\--cleanup]
| {*instance*}
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.
+If the ``--cleanup`` option is passed, the operation changes from
+performin a failover to attempting recovery from a failed previous failover.
+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.
+
See **ganeti**\(7) for a description of ``--submit`` and other common
options.
# 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.
-Alternatively, the default iallocator can be requested by specifying
-``.`` as the name of the plugin.
-
-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' disks
are configured correctly. In this mode, the ``--non-live`` option is
| [-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
projects / ganeti-local / blobdiff