| {{-n|--node} *node[:secondary-node]* \| {-I|--iallocator} *name*}
| {{-o|--os-type} *os-type*}
| [--submit]
+| [--ignore-ipolicy]
| {*instance*}
Creates a new instance on the specified host. The *instance* argument
instance's disks. Ganeti will rename these volumes to the standard
format, and (without installing the OS) will use them as-is for the
instance. This allows migrating instances from non-managed mode
-(e.q. plain KVM with LVM) to being managed via Ganeti. Note that
+(e.g. plain KVM with LVM) to being managed via Ganeti. Please note that
this works only for the \`plain' disk template (see below for
template details).
parameters for the instance. If no such parameters are specified, the
values are inherited from the cluster. Possible parameters are:
-memory
- the memory size of the instance; as usual, suffixes can be used to
- denote the unit, otherwise the value is taken in mebibites
+maxmem
+ the maximum memory size of the instance; as usual, suffixes can be
+ used to denote the unit, otherwise the value is taken in mebibytes
+
+minmem
+ the minimum memory size of the instance; as usual, suffixes can be
+ used to denote the unit, otherwise the value is taken in mebibytes
vcpus
the number of VCPUs to assign to the instance (if this value makes
whether the instance is considered in the N+1 cluster checks
(enough redundancy in the cluster to survive a node failure)
+always\_failover
+ ``True`` or ``False``, whether the instance must be failed over
+ (shut down and rebooted) always or it may be migrated (briefly
+ suspended)
+
+Note that before 2.6 Ganeti had a ``memory`` parameter, which was the
+only value of memory an instance could have. With the
+``maxmem``/``minmem`` change Ganeti guarantees that at least the minimum
+memory is always available for an instance, but allows more memory to be
+used (up to the maximum memory) should it be free.
The ``-H (--hypervisor-parameters)`` option specified the hypervisor
to use for the instance (must be one of the enabled hypervisors on the
n
network boot (PXE)
- The default is not to set an HVM boot order which is interpreted
+ The default is not to set an HVM boot order, which is interpreted
as 'dc'.
For KVM the boot order is either "floppy", "cdrom", "disk" or
blockdev\_prefix
Valid for the Xen HVM and PVM hypervisors.
- Relevant to nonpvops guest kernels, in which the disk device names
- are given by the host. Allows to specify 'xvd', which helps run
+ Relevant to non-pvops guest kernels, in which the disk device names
+ are given by the host. Allows one to specify 'xvd', which helps run
Red Hat based installers, driven by anaconda.
floppy\_image\_path
vnc\_x509\_verify
Valid for the KVM hypervisor.
+spice\_bind
+ Valid for the KVM hypervisor.
+
+ Specifies the address or interface on which the SPICE server will
+ listen. Valid values are:
+
+ - IPv4 addresses, including 0.0.0.0 and 127.0.0.1
+ - IPv6 addresses, including :: and ::1
+ - names of network interfaces
+
+ If a network interface is specified, the SPICE server will be bound
+ to one of the addresses of that interface.
+
+spice\_ip\_version
+ Valid for the KVM hypervisor.
+
+ Specifies which version of the IP protocol should be used by the
+ SPICE server.
+
+ It is mainly intended to be used for specifying what kind of IP
+ addresses should be used if a network interface with both IPv4 and
+ IPv6 addresses is specified via the ``spice_bind`` parameter. In
+ this case, if the ``spice_ip_version`` parameter is not used, the
+ default IP version of the cluster will be used.
+
+spice\_password\_file
+ Valid for the KVM hypervisor.
+
+ Specifies a file containing the password that must be used when
+ connecting via the SPICE protocol. If the option is not specified,
+ passwordless connections are allowed.
+
+spice\_image\_compression
+ Valid for the KVM hypervisor.
+
+ Configures the SPICE lossless image compression. Valid values are:
+
+ - auto_glz
+ - auto_lz
+ - quic
+ - glz
+ - lz
+ - off
+
+spice\_jpeg\_wan\_compression
+ Valid for the KVM hypervisor.
+
+ Configures how SPICE should use the jpeg algorithm for lossy image
+ compression on slow links. Valid values are:
+
+ - auto
+ - never
+ - always
+
+spice\_zlib\_glz\_wan\_compression
+ Valid for the KVM hypervisor.
+
+ Configures how SPICE should use the zlib-glz algorithm for lossy image
+ compression on slow links. Valid values are:
+
+ - auto
+ - never
+ - always
+
+spice\_streaming\_video
+ Valid for the KVM hypervisor.
+
+ Configures how SPICE should detect video streams. Valid values are:
+
+ - off
+ - all
+ - filter
+
+spice\_playback\_compression
+ Valid for the KVM hypervisor.
+
+ Configures whether SPICE should compress audio streams or not.
+
+spice\_use\_tls
+ Valid for the KVM hypervisor.
+
+ Specifies that the SPICE server must use TLS to encrypt all the
+ traffic with the client.
+
+spice\_tls\_ciphers
+ Valid for the KVM hypervisor.
+
+ Specifies a list of comma-separated ciphers that SPICE should use
+ for TLS connections. For the format, see man cipher(1).
+
+spice\_use\_vdagent
+ Valid for the KVM hypervisor.
+
+ Enables or disables passing mouse events via SPICE vdagent.
+
acpi
Valid for the Xen HVM and KVM hypervisors.
"mouse" or "tablet". When using VNC it's recommended to set it to
"tablet".
+keymap
+ Valid for the KVM hypervisor.
+
+ This option specifies the keyboard mapping to be used. It is only
+ needed when using the VNC console. For example: "fr" or "en-gb".
+
+reboot\_behavior
+ Valid for Xen PVM, Xen HVM and KVM hypervisors.
+
+ Normally if an instance reboots, the hypervisor will restart it. If
+ this option is set to ``exit``, the hypervisor will treat a reboot
+ as a shutdown instead.
+
+ It is set to ``reboot`` by default.
+
The ``-O (--os-parameters)`` option allows customisation of the OS
parameters. The actual parameter names and values depends on the OS
but not wait for its completion. The job ID will be shown so that it
can be examined via **gnt-job info**.
+If ``--ignore-ipolicy`` is given any instance policy violations occuring
+during this operation are ignored.
+
Example::
- # gnt-instance add -t file --disk 0:size=30g -B memory=512 -o debian-etch \
+ # gnt-instance add -t file --disk 0:size=30g -B maxmem=512 -o debian-etch \
-n node1.example.com --file-storage-dir=mysubdir instance1.example.com
- # gnt-instance add -t plain --disk 0:size=30g -B memory=512 -o debian-etch \
- -n node1.example.com instance1.example.com
+ # gnt-instance add -t plain --disk 0:size=30g -B maxmem=1024,minmem=512 \
+ -o debian-etch -n node1.example.com instance1.example.com
# gnt-instance add -t plain --disk 0:size=30g --disk 1:size=100g,vg=san \
- -B memory=512 -o debian-etch -n node1.example.com instance1.example.com
- # gnt-instance add -t drbd --disk 0:size=30g -B memory=512 -o debian-etch \
+ -B maxmem=512 -o debian-etch -n node1.example.com instance1.example.com
+ # gnt-instance add -t drbd --disk 0:size=30g -B maxmem=512 -o debian-etch \
-n node1.example.com:node2.example.com instance2.example.com
"iallocator": "dumb",
"hypervisor": "xen-hvm",
"hvparams": {"acpi": true},
- "backend": {"memory": 512}
+ "backend": {"maxmem": 512, "minmem": 256}
}
}
^^^^^^
**remove** [--ignore-failures] [--shutdown-timeout=*N*] [--submit]
-{*instance*}
+[--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
but not wait for its completion. The job ID will be shown so that it
can be examined via **gnt-job info**.
+The ``--force`` option is used to skip the interactive confirmation.
+
Example::
# gnt-instance remove instance1.example.com
| **list**
| [--no-headers] [--separator=*SEPARATOR*] [--units=*UNITS*] [-v]
-| [{-o|--output} *[+]FIELD,...*] [instance...]
+| [{-o|--output} *[+]FIELD,...*] [--filter] [instance...]
Shows the currently configured instances with memory usage, disk
usage, the node they are running on, and their run status.
The ``-o (--output)`` option takes a comma-separated list of output
fields. The available fields and their meaning are:
-name
- the instance name
-
-os
- the OS of the instance
-
-pnode
- the primary node of the instance
-
-snodes
- comma-separated list of secondary nodes for the instance; usually
- this will be just one node
-
-admin\_state
- the desired state of the instance (either "yes" or "no" denoting
- the instance should run or not)
-
-disk\_template
- the disk template of the instance
-
-oper\_state
- the actual state of the instance; can be one of the values
- "running", "stopped", "(node down)"
-
-status
- combined form of ``admin_state`` and ``oper_stat``; this can be one of:
- ``ERROR_nodedown`` if the node of the instance is down, ``ERROR_down`` if
- the instance should run but is down, ``ERROR_up`` if the instance should be
- stopped but is actually running, ``ERROR_wrongnode`` if the instance is
- running but not on the primary, ``ADMIN_down`` if the instance has been
- stopped (and is stopped) and ``running`` if the instance is set to be
- running (and is running)
-
-oper\_ram
- the actual memory usage of the instance as seen by the hypervisor
-
-oper\_vcpus
- the actual number of VCPUs the instance is using as seen by the
- hypervisor
-
-ip
- the ip address Ganeti recognizes as associated with the first
- instance interface
-
-mac
- the first instance interface MAC address
-
-nic\_mode
- the mode of the first instance NIC (routed or bridged)
-
-nic\_link
- the link of the first instance NIC
-
-sda\_size
- the size of the instance's first disk
-
-sdb\_size
- the size of the instance's second disk, if any
-
-vcpus
- the number of VCPUs allocated to the instance
-
-tags
- comma-separated list of the instances's tags
-
-serial\_no
- the so called 'serial number' of the instance; this is a numeric
- field that is incremented each time the instance is modified, and
- it can be used to track modifications
-
-ctime
- the creation time of the instance; note that this field contains
- spaces and as such it's harder to parse
-
- if this attribute is not present (e.g. when upgrading from older
- versions), then "N/A" will be shown instead
-
-mtime
- the last modification time of the instance; note that this field
- contains spaces and as such it's harder to parse
-
- if this attribute is not present (e.g. when upgrading from older
- versions), then "N/A" will be shown instead
-
-uuid
- Show the UUID of the instance (generated automatically by Ganeti)
-
-network\_port
- If the instance has a network port assigned to it (e.g. for VNC
- connections), this will be shown, otherwise - will be displayed.
-
-beparams
- A text format of the entire beparams for the instance. It's more
- useful to select individual fields from this dictionary, see
- below.
-
-disk.count
- The number of instance disks.
-
-disk.size/N
- The size of the instance's Nth disk. This is a more generic form of
- the sda\_size and sdb\_size fields.
-
-disk.sizes
- A comma-separated list of the disk sizes for this instance.
-
-disk\_usage
- The total disk space used by this instance on each of its nodes.
- This is not the instance-visible disk size, but the actual disk
- "cost" of the instance.
-
-nic.mac/N
- The MAC of the Nth instance NIC.
-
-nic.ip/N
- The IP address of the Nth instance NIC.
-
-nic.mode/N
- The mode of the Nth instance NIC
-
-nic.link/N
- The link of the Nth instance NIC
-
-nic.macs
- A comma-separated list of all the MACs of the instance's NICs.
-
-nic.ips
- A comma-separated list of all the IP addresses of the instance's
- NICs.
-
-nic.modes
- A comma-separated list of all the modes of the instance's NICs.
-
-nic.links
- A comma-separated list of all the link parameters of the instance's
- NICs.
-
-nic.count
- The number of instance nics.
-
-hv/*NAME*
- The value of the hypervisor parameter called *NAME*. For details of
- what hypervisor parameters exist and their meaning, see the **add**
- command.
-
-be/memory
- The configured memory for the instance.
-
-be/vcpus
- The configured number of VCPUs for the instance.
-
-be/auto\_balance
- Whether the instance is considered in N+1 checks.
-
+@QUERY_FIELDS_INSTANCE@
If the value of the option starts with the character ``+``, the new
-field(s) will be added to the default list. This allows to quickly see
-the default list plus a few other fields, instead of retyping the
+field(s) will be added to the default list. This allows one to quickly
+see the default list plus a few other fields, instead of retyping the
entire list of fields.
There is a subtle grouping about the available output fields: all
you only want some data and it makes sense to specify a reduced set of
output fields.
-The default output field list is: name, os, pnode, admin\_state,
-oper\_state, oper\_ram.
+If exactly one argument is given and it appears to be a query filter
+(see **ganeti(7)**), the query result is filtered accordingly. For
+ambiguous cases (e.g. a single field name as a filter) the ``--filter``
+(``-F``) option forces the argument to be treated as a filter (e.g.
+``gnt-instance list -F admin_state``).
+
+The default output field list is: ``name``, ``os``, ``pnode``,
+``admin_state``, ``oper_state``, ``oper_ram``.
LIST-FIELDS
| **modify**
| [{-H|--hypervisor-parameters} *HYPERVISOR\_PARAMETERS*]
| [{-B|--backend-parameters} *BACKEND\_PARAMETERS*]
+| [{-m|--runtime-memory} *SIZE*]
| [--net add*[:options]* \| --net remove \| --net *N:options*]
| [--disk add:size=*SIZE*[,vg=*VG*][,metavg=*VG*] \| --disk remove \|
| --disk *N*:mode=*MODE*]
| [{-t|--disk-template} plain | {-t|--disk-template} drbd -n *new_secondary*] [--no-wait-for-sync]
| [--os-type=*OS* [--force-variant]]
| [{-O|--os-parameters} *param*=*value*... ]
+| [--offline \| --online]
| [--submit]
+| [--ignore-ipolicy]
| {*instance*}
Modifies the memory size, number of vcpus, ip address, MAC address
to the ``drbd`` template in order to make the instance available for
startup before DRBD has finished resyncing.
+The ``-m (--runtime-memory)`` option will change an instance's runtime
+memory to the given size (in MB if a different suffix is not specified),
+by ballooning it up or down to the new value.
+
The ``--disk add:size=``*SIZE* option adds a disk to the instance. The
optional ``vg=``*VG* option specifies LVM volume group other than
default vg to create the disk on. For DRBD disks, the ``metavg=``*VG*
``--force-variant`` is passed. An invalid OS will also be refused,
unless the ``--force`` option is given.
+The ``--online`` and ``--offline`` options are used to transition an
+instance into and out of the ``offline`` state. An instance can be
+turned offline only if it was previously down. The ``--online`` option
+fails if the instance was not in the ``offline`` state, otherwise it
+changes instance's state to ``down``. These modifications take effect
+immediately.
+
The ``--submit`` option is used to send the job to the master daemon
but not wait for its completion. The job ID will be shown so that it
can be examined via **gnt-job info**.
-All the changes take effect at the next restart. If the instance is
+If ``--ignore-ipolicy`` is given any instance policy violations occuring
+during this operation are ignored.
+
+Most of the changes take effect at the next restart. If the instance is
running, there is no effect on the instance.
REINSTALL
the ``--no-ip-check`` option is passed.
The ``--no-name-check`` skips the check for the new instance name via
-the resolver (e.g. in DNS or /etc/hosts, depending on your
-setup). Since the name check is used to compute the IP address, if you
-pass this option you must also pass the ``--no-ip-check`` option.
+the resolver (e.g. in DNS or /etc/hosts, depending on your setup) and
+that the resolved name matches the provided name. Since the name check
+is used to compute the IP address, if you pass this option you must also
+pass the ``--no-ip-check`` option.
The ``--submit`` option is used to send the job to the master daemon
but not wait for its completion. The job ID will be shown so that it
| --tags \| --node-tags \| --pri-node-tags \| --sec-node-tags]
| [{-H|--hypervisor-parameters} ``key=value...``]
| [{-B|--backend-parameters} ``key=value...``]
-| [--submit]
+| [--submit] [--paused]
| {*name*...}
Starts one or more instances, depending on the following options. The
will start all instances in the cluster on secondary nodes with the
tags given as arguments
-
Note that although you can pass more than one selection option, the
last one wins, so in order to guarantee the desired result, don't pass
more than one such option.
useful for quick testing without having to modify an instance back and
forth, e.g.::
- # gnt-instance start -H root_args="single" instance1
- # gnt-instance start -B memory=2048 instance2
+ # gnt-instance start -H kernel_args="single" instance1
+ # gnt-instance start -B maxmem=2048 instance2
The first form will start the instance instance1 in single-user mode,
and the instance instance2 with 2GB of RAM (this time only, unless
that is the actual instance memory size already). Note that the values
override the instance parameters (and not extend them): an instance
-with "root\_args=ro" when started with -H root\_args=single will
+with "kernel\_args=ro" when started with -H kernel\_args=single will
result in "single", not "ro single". The ``--submit`` option is used
to send the job to the master daemon but not wait for its
completion. The job ID will be shown so that it can be examined via
**gnt-job info**.
+The ``--paused`` option is only valid for Xen and kvm hypervisors. This
+pauses the instance at the start of bootup, awaiting ``gnt-instance
+console`` to unpause it, allowing the entire boot process to be
+monitored for debugging.
+
Example::
# gnt-instance start instance1.example.com
HVM instance, use a VNC client with the connection info from the
**info** command.
+For Xen/kvm instances, if the instance is paused, this attempts to
+unpause the instance after waiting a few seconds for the connection to
+the console to be made.
+
Example::
# gnt-instance console instance1.example.com
REPLACE-DISKS
^^^^^^^^^^^^^
-**replace-disks** [--submit] [--early-release] {-p} [--disks *idx*]
-{*instance*}
+**replace-disks** [--submit] [--early-release] [--ignore-ipolicy] {-p}
+[--disks *idx*] {*instance*}
-**replace-disks** [--submit] [--early-release] {-s} [--disks *idx*]
-{*instance*}
+**replace-disks** [--submit] [--early-release] [--ignore-ipolicy] {-s}
+[--disks *idx*] {*instance*}
-**replace-disks** [--submit] [--early-release] {--iallocator *name*
-\| --new-secondary *NODE*} {*instance*}
+**replace-disks** [--submit] [--early-release] [--ignore-ipolicy]
+{--iallocator *name* \| -- {*instance*}
-**replace-disks** [--submit] [--early-release] {--auto}
-{*instance*}
+**replace-disks** [--submit] [--early-release] [--ignore-ipolicy]
+{--auto} {*instance*}
This command is a generalized form for replacing disks. It is
currently only valid for the mirrored (DRBD) disk template.
broken) or when the storage on the primary node is known to be fine
(thus we won't need the old storage for potential recovery).
+The ``--ignore-ipolicy`` let the command ignore instance policy
+violations if replace-disks changes groups and the instance would
+violate the new groups instance policy.
+
Note that it is not possible to select an offline or drained node as a
new secondary.
RECREATE-DISKS
^^^^^^^^^^^^^^
-**recreate-disks** [--submit] [--disks=``indices``] [-n node1:[node2]]
- {*instance*}
+| **recreate-disks** [--submit] [-n node1:[node2]]
+| [--disk=*N*[:[size=*VAL*][,mode=*ro\|rw*]]] {*instance*}
-Recreates the disks of the given instance, or only a subset of the
-disks (if the option ``disks`` is passed, which must be a
-comma-separated list of disk indices, starting from zero).
+Recreates all or a subset of disks of the given instance.
Note that this functionality should only be used for missing disks; if
any of the given disks already exists, the operation will fail. While
this is suboptimal, recreate-disks should hopefully not be needed in
normal operation and as such the impact of this is low.
+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.
+
Optionally the instance's disks can be recreated on different
nodes. This can be useful if, for example, the original nodes of the
instance have gone down (and are marked offline), so we can't recreate
on the same nodes. To do this, pass the new node(s) via ``-n`` option,
with a syntax similar to the **add** command. The number of nodes
passed must equal the number of nodes that the instance currently
-has. Note that changing nodes is only allowed for 'all disk'
-replacement (when ``--disks`` is not passed).
+has. Note that changing nodes is only allowed when all disks are
+replaced, e.g. when no ``--disk`` option is passed.
The ``--submit`` option is used to send the job to the master daemon
but not wait for its completion. The job ID will be shown so that it
^^^^^^^^
**failover** [-f] [--ignore-consistency] [--shutdown-timeout=*N*]
-[--submit] {*instance*}
+[--submit] [--ignore-ipolicy] {*instance*}
-Failover will fail the instance over its secondary node. This works
-only for instances having a drbd disk template.
+Failover will stop the instance (if running), change its primary node,
+and if it was originally running it will start it again (on the new
+primary). This only works for instances with drbd template (in which
+case you can only fail to the secondary node) and for externally
+mirrored templates (shared storage) (which can change to any other
+node).
Normally the failover will check the consistency of the disks before
failing over the instance. If you are trying to migrate instances off
but not wait for its completion. The job ID will be shown so that it
can be examined via **gnt-job info**.
+If ``--ignore-ipolicy`` is given any instance policy violations occuring
+during this operation are ignored.
+
Example::
# gnt-instance failover instance1.example.com
**migrate** [-f] {--cleanup} {*instance*}
-**migrate** [-f] [--non-live] [--migration-mode=live\|non-live]
-{*instance*}
+**migrate** [-f] [--allow-failover] [--non-live]
+[--migration-mode=live\|non-live] [--ignore-ipolicy] {*instance*}
Migrate will move the instance to its secondary node without
shutdown. It only works for instances having the drbd8 disk template
The option ``-f`` will skip the prompting for confirmation.
+If ``--allow-failover`` is specified it tries to fallback to failover if
+it already can determine that a migration won't work (e.g. if the
+instance is shut down). Please note that the fallback will not happen
+during execution. If a migration fails during execution it still fails.
+
+If ``--ignore-ipolicy`` is given any instance policy violations occuring
+during this operation are ignored.
+
Example (and expected output)::
# gnt-instance migrate instance1
- Migrate will happen to the instance instance1. Note that migration is
- **experimental** in this version. This might impact the instance if
- anything goes wrong. Continue?
+ Instance instance1 will be migrated. Note that migration
+ might impact the instance if anything goes wrong (e.g. due to bugs in
+ the hypervisor). Continue?
y/[n]/?: y
+ Migrating instance instance1.example.com
* checking disk consistency between source and target
- * ensuring the target is in secondary mode
+ * switching node node2.example.com to secondary mode
+ * changing into standalone mode
* changing disks into dual-master mode
- - INFO: Waiting for instance instance1 to sync disks.
- - INFO: Instance instance1's disks are in sync.
+ * wait until resync is done
+ * preparing node2.example.com to accept the instance
* migrating instance to node2.example.com
- * changing the instance's disks on source node to secondary
- - INFO: Waiting for instance instance1 to sync disks.
- - INFO: Instance instance1's disks are in sync.
- * changing the instance's disks to single-master
+ * switching node node1.example.com to secondary mode
+ * wait until resync is done
+ * changing into standalone mode
+ * changing disks into single-master mode
+ * wait until resync is done
+ * done
#
^^^^
**move** [-f] [--ignore-consistency]
-[-n *node*] [--shutdown-timeout=*N*] [--submit]
+[-n *node*] [--shutdown-timeout=*N*] [--submit] [--ignore-ipolicy]
{*instance*}
Move will move the instance to an arbitrary node in the cluster. This
but not wait for its completion. The job ID will be shown so that it
can be examined via **gnt-job info**.
+If ``--ignore-ipolicy`` is given any instance policy violations occuring
+during this operation are ignored.
+
Example::
# gnt-instance move -n node3.example.com instance1.example.com
+CHANGE-GROUP
+~~~~~~~~~~~~
+
+**change-group** [--iallocator *NAME*] [--to *GROUP*...] {*instance*}
+
+This command moves an instance to another node group. The move is
+calculated by an iallocator, either given on the command line or as a
+cluster default.
+
+If no specific destination groups are specified using ``--to``, all
+groups except the one containing the instance are considered.
+
+Example::
+
+ # gnt-instance change-group -I hail --to rack2 inst1.example.com
+
+
TAGS
~~~~
In this case, there is not need to pass tags on the command line (if
you do, tags from both sources will be removed). A file name of ``-``
will be interpreted as stdin.
+
+.. vim: set textwidth=72 :
+.. Local Variables:
+.. mode: rst
+.. fill-column: 72
+.. End: