^^^
| **add**
-| {-t|\--disk-template {diskless | file \| plain \| drbd \| rbd}}
-| {\--disk=*N*: {size=*VAL* \| adopt=*LV*}[,vg=*VG*][,metavg=*VG*][,mode=*ro\|rw*]
+| {-t|\--disk-template {diskless \| file \| plain \| drbd \| rbd}}
+| {\--disk=*N*: {size=*VAL*[,spindles=*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*... ]]
| [\--file-storage-dir *dir\_path*] [\--file-driver {loop \| blktap}]
| {{-n|\--node} *node[:secondary-node]* \| {-I|\--iallocator} *name*}
| {{-o|\--os-type} *os-type*}
-| [\--submit]
+| [\--submit] [\--print-job-id]
| [\--ignore-ipolicy]
| {*instance*}
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):
+
+spindles
+ How many spindles (physical disks on the node) the disk should span.
+
+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.
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.
- 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.
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.
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.
+
+ 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.
Example:
- .. code-block:: Bash
+ .. code-block:: bash
# Map the entire instance to CPUs 0-2
gnt-instance modify -H cpu_mask=0-2 my-inst
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. 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
please refer to the instance allocator documentation.
The ``-t (--disk-template)`` options specifies the disk layout type
-for the instance. The available choices are:
+for the instance. If no disk template is specified, the default disk
+template is used. The default disk template is the first in the list
+of enabled disk templates, which can be adjusted cluster-wide with
+``gnt-cluster modify``. The available choices for disk templates are:
diskless
This creates an instance with no disks. Its useful for testing only
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.
useful for having different subdirectories for different
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
-option is only relevant for instances using the file storage backend.
+subdirectory + instance name. This 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
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
^^^^^^^^^^^^
-**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
^^^^^^
-**remove** [\--ignore-failures] [\--shutdown-timeout=*N*] [\--submit]
-[\--force] {*instance*}
+| **remove** [\--ignore-failures] [\--shutdown-timeout=*N*] [\--submit]
+| [\--print-job-id] [\--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
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 [*N*:]remove \| \--net *N:options*]
-| [\--disk add:size=*SIZE*[,vg=*VG*][,metavg=*VG*] \| \--disk [*N*:]remove \|
-| \--disk *N*:mode=*MODE*]
-| [{-t|\--disk-template} plain | {-t|\--disk-template} drbd -n *new_secondary*] [\--no-wait-for-sync]
+| [\--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]
+| [\--submit] [\--print-job-id]
| [\--ignore-ipolicy]
| {*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(``spindles``, ``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...]`` will 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
| **reinstall** [{-o|\--os-type} *os-type*] [\--select-os] [-f *force*]
| [\--force-multiple]
| [\--instance \| \--node \| \--primary \| \--secondary \| \--all]
-| [{-O|\--os-parameters} *OS\_PARAMETERS*] [\--submit] {*instance*...}
+| [{-O|\--os-parameters} *OS\_PARAMETERS*] [\--submit] [\--print-job-id]
+| {*instance*...}
Reinstalls the operating system on the given instance(s). The
instance(s) must be stopped when running this command. If the ``-o
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
^^^^^^
-| **rename** [\--no-ip-check] [\--no-name-check] [\--submit]
+| **rename** [\--no-ip-check] [\--no-name-check] [\--submit] [\--print-job-id]
| {*instance*} {*new\_name*}
Renames the given instance. The instance must be stopped when running
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
| \--tags \| \--node-tags \| \--pri-node-tags \| \--sec-node-tags]
| [{-H|\--hypervisor-parameters} ``key=value...``]
| [{-B|\--backend-parameters} ``key=value...``]
-| [\--submit] [\--paused]
+| [\--submit] [\--print-job-id] [\--paused]
| {*name*...}
Starts one or more instances, depending on the following options. The
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]
+| [\--submit] [\--print-job-id]
| {*name*...}
Stops one or more instances. If the instance cannot be cleanly stopped
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::
| [\--force-multiple]
| [\--instance \| \--node \| \--primary \| \--secondary \| \--all \|
| \--tags \| \--node-tags \| \--pri-node-tags \| \--sec-node-tags]
-| [\--submit]
+| [\--submit] [\--print-job-id]
| [*name*...]
Reboots one or more instances. The type of reboot depends on the value
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::
REPLACE-DISKS
^^^^^^^^^^^^^
-**replace-disks** [\--submit] [\--early-release] [\--ignore-ipolicy] {-p}
-[\--disks *idx*] {*instance*}
+| **replace-disks** [\--submit] [\--print-job-id] [\--early-release]
+| [\--ignore-ipolicy] {-p} [\--disks *idx*] {*instance*}
-**replace-disks** [\--submit] [\--early-release] [\--ignore-ipolicy] {-s}
-[\--disks *idx*] {*instance*}
+| **replace-disks** [\--submit] [\--print-job-id] [\--early-release]
+| [\--ignore-ipolicy] {-s} [\--disks *idx*] {*instance*}
-**replace-disks** [\--submit] [\--early-release] [\--ignore-ipolicy]
-{{-I\|\--iallocator} *name* \| {{-n|\--new-secondary} *node* } {*instance*}
+| **replace-disks** [\--submit] [\--print-job-id] [\--early-release]
+| [\--ignore-ipolicy]
+| {{-I\|\--iallocator} *name* \| {{-n|\--new-secondary} *node* } {*instance*}
-**replace-disks** [\--submit] [\--early-release] [\--ignore-ipolicy]
-{-a\|\--auto} {*instance*}
+| **replace-disks** [\--submit] [\--print-job-id] [\--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.
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
^^^^^^^^^^^^^^
-**activate-disks** [\--submit] [\--ignore-size] [\--wait-for-sync] {*instance*}
+| **activate-disks** [\--submit] [\--print-job-id] [\--ignore-size]
+| [\--wait-for-sync] {*instance*}
Activates the block devices of the given instance. If successful, the
command will show the location and name of the block devices::
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
^^^^^^^^^^^^^^^^
-**deactivate-disks** [-f] [\--submit] {*instance*}
+**deactivate-disks** [-f] [\--submit] [\--print-job-id] {*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
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
^^^^^^^^^
-| **grow-disk** [\--no-wait-for-sync] [\--submit] [\--absolute]
+| **grow-disk** [\--no-wait-for-sync] [\--submit] [\--print-job-id]
+| [\--absolute]
| {*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)::
RECREATE-DISKS
^^^^^^^^^^^^^^
-| **recreate-disks** [\--submit]
+| **recreate-disks** [\--submit] [\--print-job-id]
| [{-n node1:[node2] \| {-I\|\--iallocator *name*}}]
-| [\--disk=*N*[:[size=*VAL*][,mode=*ro\|rw*]]] {*instance*}
+| [\--disk=*N*[:[size=*VAL*][,spindles=*VAL*][,mode=*ro\|rw*]]] {*instance*}
Recreates all or a subset of disks of the given instance.
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.
+parameters to change. Only ``size``, ``spindles``, 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.
Optionally the instance's disks can be recreated on different
nodes. This can be useful if, for example, the original nodes of the
The primary and secondary nodes will be chosen by the specified
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** [-f] [\--ignore-consistency] [\--ignore-ipolicy]
| [\--shutdown-timeout=*N*]
| [{-n|\--target-node} *node* \| {-I|\--iallocator} *name*]
-| [\--submit]
+| [\--cleanup]
+| [\--submit] [\--print-job-id]
| {*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.
-See **ganeti(7)** for a description of ``--submit`` and other common
+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.
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] [\--allow-failover] [\--non-live]
| [\--migration-mode=live\|non-live] [\--ignore-ipolicy]
-| [\--no-runtime-changes] [\--submit]
+| [\--no-runtime-changes] [\--submit] [\--print-job-id]
| [{-n|\--target-node} *node* \| {-I|\--iallocator} *name*] {*instance*}
-| **migrate** [-f] \--cleanup [\--submit] {*instance*}
+| **migrate** [-f] \--cleanup [\--submit] [\--print-job-id] {*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
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
+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
+See **ganeti**\(7) for a description of ``--submit`` and other common
options.
Example (and expected output)::
^^^^
| **move** [-f] [\--ignore-consistency]
-| [-n *node*] [\--shutdown-timeout=*N*] [\--submit] [\--ignore-ipolicy]
+| [-n *node*] [\--shutdown-timeout=*N*] [\--submit] [\--print-job-id]
+| [\--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]
+| **change-group** [\--submit] [\--print-job-id]
| [\--iallocator *NAME*] [\--to *GROUP*...] {*instance*}
This command moves an instance to another node group. The move is
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