Statistics
| Branch: | Tag: | Revision:

root / man / gnt-instance.rst @ 0271b044

History | View | Annotate | Download (72.3 kB)

1
gnt-instance(8) Ganeti | Version @GANETI_VERSION@
2
=================================================
3

    
4
Name
5
----
6

    
7
gnt-instance - Ganeti instance administration
8

    
9
Synopsis
10
--------
11

    
12
**gnt-instance** {command} [arguments...]
13

    
14
DESCRIPTION
15
-----------
16

    
17
The **gnt-instance** command is used for instance administration in
18
the Ganeti system.
19

    
20
COMMANDS
21
--------
22

    
23
Creation/removal/querying
24
~~~~~~~~~~~~~~~~~~~~~~~~~
25

    
26
ADD
27
^^^
28

    
29
| **add**
30
| {-t|\--disk-template {diskless | file \| plain \| drbd \| rbd}}
31
| {\--disk=*N*: {size=*VAL* \| adopt=*LV*}[,options...]
32
|  \| {size=*VAL*,provider=*PROVIDER*}[,param=*value*... ][,options...]
33
|  \| {-s|\--os-size} *SIZE*}
34
| [\--no-ip-check] [\--no-name-check] [\--no-conflicts-check]
35
| [\--no-start] [\--no-install]
36
| [\--net=*N* [:options...] \| \--no-nics]
37
| [{-B|\--backend-parameters} *BEPARAMS*]
38
| [{-H|\--hypervisor-parameters} *HYPERVISOR* [: option=*value*... ]]
39
| [{-O|\--os-parameters} *param*=*value*... ]
40
| [\--file-storage-dir *dir\_path*] [\--file-driver {loop \| blktap \| blktap2}]
41
| {{-n|\--node} *node[:secondary-node]* \| {-I|\--iallocator} *name*}
42
| {{-o|\--os-type} *os-type*}
43
| [\--submit]
44
| [\--ignore-ipolicy]
45
| {*instance*}
46

    
47
Creates a new instance on the specified host. The *instance* argument
48
must be in DNS, but depending on the bridge/routing setup, need not be
49
in the same network as the nodes in the cluster.
50

    
51
The ``disk`` option specifies the parameters for the disks of the
52
instance. The numbering of disks starts at zero, and at least one disk
53
needs to be passed. For each disk, either the size or the adoption
54
source needs to be given. The size is interpreted (when no unit is
55
given) in mebibytes. You can also use one of the suffixes *m*, *g* or
56
*t* to specify the exact the units used; these suffixes map to
57
mebibytes, gibibytes and tebibytes. Each disk can also take these
58
parameters (all optional):
59

    
60
mode
61
  The access mode. Either ``ro`` (read-only) or the default ``rw``
62
  (read-write).
63

    
64
name
65
   this option specifies a name for the disk, which can be used as a disk
66
   identifier. An instance can not have two disks with the same name.
67

    
68
vg
69
   The LVM volume group. This works only for LVM and DRBD devices.
70

    
71
metavg
72
   This options specifies a different VG for the metadata device. This
73
   works only for DRBD devices
74

    
75
When creating ExtStorage disks, also arbitrary parameters can be passed,
76
to the ExtStorage provider. Those parameters are passed as additional
77
comma separated options. Therefore, an ExtStorage disk provided by
78
provider ``pvdr1`` with parameters ``param1``, ``param2`` would be
79
passed as ``--disk 0:size=10G,provider=pvdr1,param1=val1,param2=val2``.
80

    
81
When using the ``adopt`` key in the disk definition, Ganeti will
82
reuse those volumes (instead of creating new ones) as the
83
instance's disks. Ganeti will rename these volumes to the standard
84
format, and (without installing the OS) will use them as-is for the
85
instance. This allows migrating instances from non-managed mode
86
(e.g. plain KVM with LVM) to being managed via Ganeti. Please note that
87
this works only for the \`plain' disk template (see below for
88
template details).
89

    
90
Alternatively, a single-disk instance can be created via the ``-s``
91
option which takes a single argument, the size of the disk. This is
92
similar to the Ganeti 1.2 version (but will only create one disk).
93

    
94
The minimum disk specification is therefore ``--disk 0:size=20G`` (or
95
``-s 20G`` when using the ``-s`` option), and a three-disk instance
96
can be specified as ``--disk 0:size=20G --disk 1:size=4G --disk
97
2:size=100G``.
98

    
99
The minimum information needed to specify an ExtStorage disk are the
100
``size`` and the ``provider``. For example:
101
``--disk 0:size=20G,provider=pvdr1``.
102

    
103
The ``--no-ip-check`` skips the checks that are done to see if the
104
instance's IP is not already alive (i.e. reachable from the master
105
node).
106

    
107
The ``--no-name-check`` skips the check for the instance name via
108
the resolver (e.g. in DNS or /etc/hosts, depending on your setup).
109
Since the name check is used to compute the IP address, if you pass
110
this option you must also pass the ``--no-ip-check`` option.
111

    
112
If you don't want the instance to automatically start after
113
creation, this is possible via the ``--no-start`` option. This will
114
leave the instance down until a subsequent **gnt-instance start**
115
command.
116

    
117
The NICs of the instances can be specified via the ``--net``
118
option. By default, one NIC is created for the instance, with a
119
random MAC, and set up according the the cluster level NIC
120
parameters. Each NIC can take these parameters (all optional):
121

    
122
mac
123
    either a value or 'generate' to generate a new unique MAC
124

    
125
ip
126
    specifies the IP address assigned to the instance from the Ganeti
127
    side (this is not necessarily what the instance will use, but what
128
    the node expects the instance to use). Note that if an IP in the
129
    range of a network configured with **gnt-network**\(8) is used,
130
    and the NIC is not already connected to it, this network has to be
131
    passed in the **network** parameter if this NIC is meant to be
132
    connected to the said network. ``--no-conflicts-check`` can be used
133
    to override this check. The special value **pool** causes Ganeti to
134
    select an IP from the the network the NIC is or will be connected to.
135
    One can pick an externally reserved IP of a network along with
136
    ``--no-conflict-check``. Note that this IP cannot be assigned to
137
    any other instance until it gets released.
138

    
139
mode
140
    specifies the connection mode for this NIC: routed, bridged or
141
    openvswitch.
142

    
143
link
144
    in bridged or openvswitch mode specifies the interface to attach
145
    this NIC to, in routed mode it's intended to differentiate between
146
    different routing tables/instance groups (but the meaning is
147
    dependent on the network script, see **gnt-cluster**\(8) for more
148
    details). Note that openvswitch support is also hypervisor
149
    dependent.
150

    
151
network
152
    derives the mode and the link from the settings of the network
153
    which is identified by its name. If the network option is chosen,
154
    link and mode must not be specified. Note that the mode and link
155
    depend on the network-to-nodegroup connection, thus allowing
156
    different nodegroups to be connected to the same network in
157
    different ways.
158

    
159
name
160
   this option specifies a name for the NIC, which can be used as a NIC
161
   identifier. An instance can not have two NICs with the same name.
162

    
163

    
164
Of these "mode" and "link" are NIC parameters, and inherit their
165
default at cluster level.  Alternatively, if no network is desired for
166
the instance, you can prevent the default of one NIC with the
167
``--no-nics`` option.
168

    
169
The ``-o (--os-type)`` option specifies the operating system to be
170
installed.  The available operating systems can be listed with
171
**gnt-os list**.  Passing ``--no-install`` will however skip the OS
172
installation, allowing a manual import if so desired. Note that the
173
no-installation mode will automatically disable the start-up of the
174
instance (without an OS, it most likely won't be able to start-up
175
successfully).
176

    
177
The ``-B (--backend-parameters)`` option specifies the backend
178
parameters for the instance. If no such parameters are specified, the
179
values are inherited from the cluster. Possible parameters are:
180

    
181
maxmem
182
    the maximum memory size of the instance; as usual, suffixes can be
183
    used to denote the unit, otherwise the value is taken in mebibytes
184

    
185
minmem
186
    the minimum memory size of the instance; as usual, suffixes can be
187
    used to denote the unit, otherwise the value is taken in mebibytes
188

    
189
vcpus
190
    the number of VCPUs to assign to the instance (if this value makes
191
    sense for the hypervisor)
192

    
193
auto\_balance
194
    whether the instance is considered in the N+1 cluster checks
195
    (enough redundancy in the cluster to survive a node failure)
196

    
197
always\_failover
198
    ``True`` or ``False``, whether the instance must be failed over
199
    (shut down and rebooted) always or it may be migrated (briefly
200
    suspended)
201

    
202
Note that before 2.6 Ganeti had a ``memory`` parameter, which was the
203
only value of memory an instance could have. With the
204
``maxmem``/``minmem`` change Ganeti guarantees that at least the minimum
205
memory is always available for an instance, but allows more memory to be
206
used (up to the maximum memory) should it be free.
207

    
208
The ``-H (--hypervisor-parameters)`` option specified the hypervisor
209
to use for the instance (must be one of the enabled hypervisors on the
210
cluster) and optionally custom parameters for this instance. If not
211
other options are used (i.e. the invocation is just -H *NAME*) the
212
instance will inherit the cluster options. The defaults below show the
213
cluster defaults at cluster creation time.
214

    
215
The possible hypervisor options are as follows:
216

    
217
boot\_order
218
    Valid for the Xen HVM and KVM hypervisors.
219

    
220
    A string value denoting the boot order. This has different meaning
221
    for the Xen HVM hypervisor and for the KVM one.
222

    
223
    For Xen HVM, The boot order is a string of letters listing the boot
224
    devices, with valid device letters being:
225

    
226
    a
227
        floppy drive
228

    
229
    c
230
        hard disk
231

    
232
    d
233
        CDROM drive
234

    
235
    n
236
        network boot (PXE)
237

    
238
    The default is not to set an HVM boot order, which is interpreted
239
    as 'dc'.
240

    
241
    For KVM the boot order is either "floppy", "cdrom", "disk" or
242
    "network".  Please note that older versions of KVM couldn't netboot
243
    from virtio interfaces. This has been fixed in more recent versions
244
    and is confirmed to work at least with qemu-kvm 0.11.1. Also note
245
    that if you have set the ``kernel_path`` option, that will be used
246
    for booting, and this setting will be silently ignored.
247

    
248
blockdev\_prefix
249
    Valid for the Xen HVM and PVM hypervisors.
250

    
251
    Relevant to non-pvops guest kernels, in which the disk device names
252
    are given by the host.  Allows one to specify 'xvd', which helps run
253
    Red Hat based installers, driven by anaconda.
254

    
255
floppy\_image\_path
256
    Valid for the KVM hypervisor.
257

    
258
    The path to a floppy disk image to attach to the instance.  This
259
    is useful to install Windows operating systems on Virt/IO disks
260
    because you can specify here the floppy for the drivers at
261
    installation time.
262

    
263
cdrom\_image\_path
264
    Valid for the Xen HVM and KVM hypervisors.
265

    
266
    The path to a CDROM image to attach to the instance.
267

    
268
cdrom2\_image\_path
269
    Valid for the KVM hypervisor.
270

    
271
    The path to a second CDROM image to attach to the instance.
272
    **NOTE**: This image can't be used to boot the system. To do that
273
    you have to use the 'cdrom\_image\_path' option.
274

    
275
nic\_type
276
    Valid for the Xen HVM and KVM hypervisors.
277

    
278
    This parameter determines the way the network cards are presented
279
    to the instance. The possible options are:
280

    
281
    - rtl8139 (default for Xen HVM) (HVM & KVM)
282
    - ne2k\_isa (HVM & KVM)
283
    - ne2k\_pci (HVM & KVM)
284
    - i82551 (KVM)
285
    - i82557b (KVM)
286
    - i82559er (KVM)
287
    - pcnet (KVM)
288
    - e1000 (KVM)
289
    - paravirtual (default for KVM) (HVM & KVM)
290

    
291
vif\_type
292
    Valid for the Xen HVM hypervisor.
293

    
294
    This parameter specifies the vif type of the nic configuration
295
    of the instance. Unsetting the value leads to no type being specified
296
    in the configuration. Note that this parameter only takes effect when
297
    the 'nic_type' is not set. The possible options are:
298

    
299
    - ioemu
300
    - vif
301

    
302
disk\_type
303
    Valid for the Xen HVM and KVM hypervisors.
304

    
305
    This parameter determines the way the disks are presented to the
306
    instance. The possible options are:
307

    
308
    - ioemu [default] (HVM & KVM)
309
    - ide (HVM & KVM)
310
    - scsi (KVM)
311
    - sd (KVM)
312
    - mtd (KVM)
313
    - pflash (KVM)
314

    
315

    
316
cdrom\_disk\_type
317
    Valid for the KVM hypervisor.
318

    
319
    This parameter determines the way the cdroms disks are presented
320
    to the instance. The default behavior is to get the same value of
321
    the earlier parameter (disk_type). The possible options are:
322

    
323
    - paravirtual
324
    - ide
325
    - scsi
326
    - sd
327
    - mtd
328
    - pflash
329

    
330

    
331
vnc\_bind\_address
332
    Valid for the Xen HVM and KVM hypervisors.
333

    
334
    Specifies the address that the VNC listener for this instance
335
    should bind to. Valid values are IPv4 addresses. Use the address
336
    0.0.0.0 to bind to all available interfaces (this is the default)
337
    or specify the address of one of the interfaces on the node to
338
    restrict listening to that interface.
339

    
340
vnc\_password\_file
341
    Valid for the Xen HVM and KVM hypervisors.
342

    
343
    Specifies the location of the file containing the password for
344
    connections using VNC. The default is a file named
345
    vnc-cluster-password which can be found in the configuration
346
    directory.
347

    
348
vnc\_tls
349
    Valid for the KVM hypervisor.
350

    
351
    A boolean option that controls whether the VNC connection is
352
    secured with TLS.
353

    
354
vnc\_x509\_path
355
    Valid for the KVM hypervisor.
356

    
357
    If ``vnc_tls`` is enabled, this options specifies the path to the
358
    x509 certificate to use.
359

    
360
vnc\_x509\_verify
361
    Valid for the KVM hypervisor.
362

    
363
spice\_bind
364
    Valid for the KVM hypervisor.
365

    
366
    Specifies the address or interface on which the SPICE server will
367
    listen. Valid values are:
368

    
369
    - IPv4 addresses, including 0.0.0.0 and 127.0.0.1
370
    - IPv6 addresses, including :: and ::1
371
    - names of network interfaces
372

    
373
    If a network interface is specified, the SPICE server will be bound
374
    to one of the addresses of that interface.
375

    
376
spice\_ip\_version
377
    Valid for the KVM hypervisor.
378

    
379
    Specifies which version of the IP protocol should be used by the
380
    SPICE server.
381

    
382
    It is mainly intended to be used for specifying what kind of IP
383
    addresses should be used if a network interface with both IPv4 and
384
    IPv6 addresses is specified via the ``spice_bind`` parameter. In
385
    this case, if the ``spice_ip_version`` parameter is not used, the
386
    default IP version of the cluster will be used.
387

    
388
spice\_password\_file
389
    Valid for the KVM hypervisor.
390

    
391
    Specifies a file containing the password that must be used when
392
    connecting via the SPICE protocol. If the option is not specified,
393
    passwordless connections are allowed.
394

    
395
spice\_image\_compression
396
    Valid for the KVM hypervisor.
397

    
398
    Configures the SPICE lossless image compression. Valid values are:
399

    
400
    - auto_glz
401
    - auto_lz
402
    - quic
403
    - glz
404
    - lz
405
    - off
406

    
407
spice\_jpeg\_wan\_compression
408
    Valid for the KVM hypervisor.
409

    
410
    Configures how SPICE should use the jpeg algorithm for lossy image
411
    compression on slow links. Valid values are:
412

    
413
    - auto
414
    - never
415
    - always
416

    
417
spice\_zlib\_glz\_wan\_compression
418
    Valid for the KVM hypervisor.
419

    
420
    Configures how SPICE should use the zlib-glz algorithm for lossy image
421
    compression on slow links. Valid values are:
422

    
423
    - auto
424
    - never
425
    - always
426

    
427
spice\_streaming\_video
428
    Valid for the KVM hypervisor.
429

    
430
    Configures how SPICE should detect video streams. Valid values are:
431

    
432
    - off
433
    - all
434
    - filter
435

    
436
spice\_playback\_compression
437
    Valid for the KVM hypervisor.
438

    
439
    Configures whether SPICE should compress audio streams or not.
440

    
441
spice\_use\_tls
442
    Valid for the KVM hypervisor.
443

    
444
    Specifies that the SPICE server must use TLS to encrypt all the
445
    traffic with the client.
446

    
447
spice\_tls\_ciphers
448
    Valid for the KVM hypervisor.
449

    
450
    Specifies a list of comma-separated ciphers that SPICE should use
451
    for TLS connections. For the format, see man **cipher**\(1).
452

    
453
spice\_use\_vdagent
454
    Valid for the KVM hypervisor.
455

    
456
    Enables or disables passing mouse events via SPICE vdagent.
457

    
458
cpu\_type
459
    Valid for the KVM hypervisor.
460

    
461
    This parameter determines the emulated cpu for the instance. If this
462
    parameter is empty (which is the default configuration), it will not
463
    be passed to KVM.
464

    
465
    Be aware of setting this parameter to ``"host"`` if you have nodes
466
    with different CPUs from each other. Live migration may stop working
467
    in this situation.
468

    
469
    For more information please refer to the KVM manual.
470

    
471
acpi
472
    Valid for the Xen HVM and KVM hypervisors.
473

    
474
    A boolean option that specifies if the hypervisor should enable
475
    ACPI support for this instance. By default, ACPI is disabled.
476

    
477
pae
478
    Valid for the Xen HVM and KVM hypervisors.
479

    
480
    A boolean option that specifies if the hypervisor should enable
481
    PAE support for this instance. The default is false, disabling PAE
482
    support.
483

    
484
viridian
485
    Valid for the Xen HVM hypervisor.
486

    
487
    A boolean option that specifies if the hypervisor should enable
488
    viridian (Hyper-V) for this instance. The default is false,
489
    disabling viridian support.
490

    
491
use\_localtime
492
    Valid for the Xen HVM and KVM hypervisors.
493

    
494
    A boolean option that specifies if the instance should be started
495
    with its clock set to the localtime of the machine (when true) or
496
    to the UTC (When false). The default is false, which is useful for
497
    Linux/Unix machines; for Windows OSes, it is recommended to enable
498
    this parameter.
499

    
500
kernel\_path
501
    Valid for the Xen PVM and KVM hypervisors.
502

    
503
    This option specifies the path (on the node) to the kernel to boot
504
    the instance with. Xen PVM instances always require this, while for
505
    KVM if this option is empty, it will cause the machine to load the
506
    kernel from its disks (and the boot will be done accordingly to
507
    ``boot_order``).
508

    
509
kernel\_args
510
    Valid for the Xen PVM and KVM hypervisors.
511

    
512
    This options specifies extra arguments to the kernel that will be
513
    loaded. device. This is always used for Xen PVM, while for KVM it
514
    is only used if the ``kernel_path`` option is also specified.
515

    
516
    The default setting for this value is simply ``"ro"``, which
517
    mounts the root disk (initially) in read-only one. For example,
518
    setting this to single will cause the instance to start in
519
    single-user mode.
520

    
521
initrd\_path
522
    Valid for the Xen PVM and KVM hypervisors.
523

    
524
    This option specifies the path (on the node) to the initrd to boot
525
    the instance with. Xen PVM instances can use this always, while
526
    for KVM if this option is only used if the ``kernel_path`` option
527
    is also specified. You can pass here either an absolute filename
528
    (the path to the initrd) if you want to use an initrd, or use the
529
    format no\_initrd\_path for no initrd.
530

    
531
root\_path
532
    Valid for the Xen PVM and KVM hypervisors.
533

    
534
    This options specifies the name of the root device. This is always
535
    needed for Xen PVM, while for KVM it is only used if the
536
    ``kernel_path`` option is also specified.
537

    
538
    Please note, that if this setting is an empty string and the
539
    hypervisor is Xen it will not be written to the Xen configuration
540
    file
541

    
542
serial\_console
543
    Valid for the KVM hypervisor.
544

    
545
    This boolean option specifies whether to emulate a serial console
546
    for the instance. Note that some versions of KVM have a bug that
547
    will make an instance hang when configured to use the serial console
548
    unless a connection is made to it within about 2 seconds of the
549
    instance's startup. For such case it's recommended to disable this
550
    option, which is enabled by default.
551

    
552
serial\_speed
553
    Valid for the KVM hypervisor.
554

    
555
    This integer option specifies the speed of the serial console.
556
    Common values are 9600, 19200, 38400, 57600 and 115200: choose the
557
    one which works on your system. (The default is 38400 for historical
558
    reasons, but newer versions of kvm/qemu work with 115200)
559

    
560
disk\_cache
561
    Valid for the KVM hypervisor.
562

    
563
    The disk cache mode. It can be either default to not pass any
564
    cache option to KVM, or one of the KVM cache modes: none (for
565
    direct I/O), writethrough (to use the host cache but report
566
    completion to the guest only when the host has committed the
567
    changes to disk) or writeback (to use the host cache and report
568
    completion as soon as the data is in the host cache). Note that
569
    there are special considerations for the cache mode depending on
570
    version of KVM used and disk type (always raw file under Ganeti),
571
    please refer to the KVM documentation for more details.
572

    
573
security\_model
574
    Valid for the KVM hypervisor.
575

    
576
    The security model for kvm. Currently one of *none*, *user* or
577
    *pool*. Under *none*, the default, nothing is done and instances
578
    are run as the Ganeti daemon user (normally root).
579

    
580
    Under *user* kvm will drop privileges and become the user
581
    specified by the security\_domain parameter.
582

    
583
    Under *pool* a global cluster pool of users will be used, making
584
    sure no two instances share the same user on the same node. (this
585
    mode is not implemented yet)
586

    
587
security\_domain
588
    Valid for the KVM hypervisor.
589

    
590
    Under security model *user* the username to run the instance
591
    under.  It must be a valid username existing on the host.
592

    
593
    Cannot be set under security model *none* or *pool*.
594

    
595
kvm\_flag
596
    Valid for the KVM hypervisor.
597

    
598
    If *enabled* the -enable-kvm flag is passed to kvm. If *disabled*
599
    -disable-kvm is passed. If unset no flag is passed, and the
600
    default running mode for your kvm binary will be used.
601

    
602
mem\_path
603
    Valid for the KVM hypervisor.
604

    
605
    This option passes the -mem-path argument to kvm with the path (on
606
    the node) to the mount point of the hugetlbfs file system, along
607
    with the -mem-prealloc argument too.
608

    
609
use\_chroot
610
    Valid for the KVM hypervisor.
611

    
612
    This boolean option determines whether to run the KVM instance in a
613
    chroot directory.
614

    
615
    If it is set to ``true``, an empty directory is created before
616
    starting the instance and its path is passed via the -chroot flag
617
    to kvm. The directory is removed when the instance is stopped.
618

    
619
    It is set to ``false`` by default.
620

    
621
migration\_downtime
622
    Valid for the KVM hypervisor.
623

    
624
    The maximum amount of time (in ms) a KVM instance is allowed to be
625
    frozen during a live migration, in order to copy dirty memory
626
    pages. Default value is 30ms, but you may need to increase this
627
    value for busy instances.
628

    
629
    This option is only effective with kvm versions >= 87 and qemu-kvm
630
    versions >= 0.11.0.
631

    
632
cpu\_mask
633
    Valid for the Xen, KVM and LXC hypervisors.
634

    
635
    The processes belonging to the given instance are only scheduled
636
    on the specified CPUs.
637

    
638
    The format of the mask can be given in three forms. First, the word
639
    "all", which signifies the common case where all VCPUs can live on
640
    any CPU, based on the hypervisor's decisions.
641

    
642
    Second, a comma-separated list of CPU IDs or CPU ID ranges. The
643
    ranges are defined by a lower and higher boundary, separated by a
644
    dash, and the boundaries are inclusive. In this form, all VCPUs of
645
    the instance will be mapped on the selected list of CPUs. Example:
646
    ``0-2,5``, mapping all VCPUs (no matter how many) onto physical CPUs
647
    0, 1, 2 and 5.
648

    
649
    The last form is used for explicit control of VCPU-CPU pinnings. In
650
    this form, the list of VCPU mappings is given as a colon (:)
651
    separated list, whose elements are the possible values for the
652
    second or first form above. In this form, the number of elements in
653
    the colon-separated list _must_ equal the number of VCPUs of the
654
    instance.
655

    
656
    Example:
657

    
658
    .. code-block:: bash
659

    
660
      # Map the entire instance to CPUs 0-2
661
      gnt-instance modify -H cpu_mask=0-2 my-inst
662

    
663
      # Map vCPU 0 to physical CPU 1 and vCPU 1 to CPU 3 (assuming 2 vCPUs)
664
      gnt-instance modify -H cpu_mask=1:3 my-inst
665

    
666
      # Pin vCPU 0 to CPUs 1 or 2, and vCPU 1 to any CPU
667
      gnt-instance modify -H cpu_mask=1-2:all my-inst
668

    
669
      # Pin vCPU 0 to any CPU, vCPU 1 to CPUs 1, 3, 4 or 5, and CPU 2 to
670
      # CPU 0 (backslashes for escaping the comma)
671
      gnt-instance modify -H cpu_mask=all:1\\,3-5:0 my-inst
672

    
673
      # Pin entire VM to CPU 0
674
      gnt-instance modify -H cpu_mask=0 my-inst
675

    
676
      # Turn off CPU pinning (default setting)
677
      gnt-instance modify -H cpu_mask=all my-inst
678

    
679
cpu\_cap
680
    Valid for the Xen hypervisor.
681

    
682
    Set the maximum amount of cpu usage by the VM. The value is a percentage
683
    between 0 and (100 * number of VCPUs). Default cap is 0: unlimited.
684

    
685
cpu\_weight
686
    Valid for the Xen hypervisor.
687

    
688
    Set the cpu time ratio to be allocated to the VM. Valid values are
689
    between 1 and 65535. Default weight is 256.
690

    
691
usb\_mouse
692
    Valid for the KVM hypervisor.
693

    
694
    This option specifies the usb mouse type to be used. It can be
695
    "mouse" or "tablet". When using VNC it's recommended to set it to
696
    "tablet".
697

    
698
keymap
699
    Valid for the KVM hypervisor.
700

    
701
    This option specifies the keyboard mapping to be used. It is only
702
    needed when using the VNC console. For example: "fr" or "en-gb".
703

    
704
reboot\_behavior
705
    Valid for Xen PVM, Xen HVM and KVM hypervisors.
706

    
707
    Normally if an instance reboots, the hypervisor will restart it. If
708
    this option is set to ``exit``, the hypervisor will treat a reboot
709
    as a shutdown instead.
710

    
711
    It is set to ``reboot`` by default.
712

    
713
cpu\_cores
714
    Valid for the KVM hypervisor.
715

    
716
    Number of emulated CPU cores.
717

    
718
cpu\_threads
719
    Valid for the KVM hypervisor.
720

    
721
    Number of emulated CPU threads.
722

    
723
cpu\_sockets
724
    Valid for the KVM hypervisor.
725

    
726
    Number of emulated CPU sockets.
727

    
728
soundhw
729
    Valid for the KVM hypervisor.
730

    
731
    Comma separated list of emulated sounds cards, or "all" to enable
732
    all the available ones.
733

    
734
usb\_devices
735
    Valid for the KVM hypervisor.
736

    
737
    Space separated list of usb devices. These can be emulated devices
738
    or passthrough ones, and each one gets passed to kvm with its own
739
    ``-usbdevice`` option. See the **qemu**\(1) manpage for the syntax
740
    of the possible components. Note that values set with this
741
    parameter are split on a space character and currently don't support
742
    quoting. For backwards compatibility reasons, the RAPI interface keeps
743
    accepting comma separated lists too.
744

    
745
vga
746
    Valid for the KVM hypervisor.
747

    
748
    Emulated vga mode, passed the the kvm -vga option.
749

    
750
kvm\_extra
751
    Valid for the KVM hypervisor.
752

    
753
    Any other option to the KVM hypervisor, useful tweaking anything
754
    that Ganeti doesn't support. Note that values set with this
755
    parameter are split on a space character and currently don't support
756
    quoting.
757

    
758
machine\_version
759
    Valid for the KVM hypervisor.
760

    
761
    Use in case an instance must be booted with an exact type of
762
    machine version (due to e.g. outdated drivers). In case it's not set
763
    the default version supported by your version of kvm is used.
764

    
765
migration\_caps
766
    Valid for the KVM hypervisor.
767

    
768
    Enable specific migration capabilities by providing a ":" separated
769
    list of supported capabilites. QEMU version 1.7.0 defines
770
    x-rdma-pin-all, auto-converge, zero-blocks, and xbzrle. Please note
771
    that while a combination of xbzrle and auto-converge might speed up
772
    the migration process significantly, the first may cause BSOD on
773
    Windows8r2 instances running on drbd.
774

    
775
kvm\_path
776
    Valid for the KVM hypervisor.
777

    
778
    Path to the userspace KVM (or qemu) program.
779

    
780
vnet\_hdr
781
    Valid for the KVM hypervisor.
782

    
783
    This boolean option determines whether the tap devices used by the
784
    KVM paravirtual nics (virtio-net) will get created with VNET_HDR
785
    (IFF_VNET_HDR) support.
786

    
787
    If set to false, it effectively disables offloading on the virio-net
788
    interfaces, which prevents host kernel tainting and log flooding,
789
    when dealing with broken or malicious virtio-net drivers.
790

    
791
    It is set to ``true`` by default.
792

    
793
The ``-O (--os-parameters)`` option allows customisation of the OS
794
parameters. The actual parameter names and values depends on the OS
795
being used, but the syntax is the same key=value. For example, setting
796
a hypothetical ``dhcp`` parameter to yes can be achieved by::
797

    
798
    gnt-instance add -O dhcp=yes ...
799

    
800
The ``-I (--iallocator)`` option specifies the instance allocator plugin
801
to use (``.`` means the default allocator). If you pass in this option
802
the allocator will select nodes for this instance automatically, so you
803
don't need to pass them with the ``-n`` option. For more information
804
please refer to the instance allocator documentation.
805

    
806
The ``-t (--disk-template)`` options specifies the disk layout type
807
for the instance.  The available choices are:
808

    
809
diskless
810
    This creates an instance with no disks. Its useful for testing only
811
    (or other special cases).
812

    
813
file
814
    Disk devices will be regular files.
815

    
816
sharedfile
817
    Disk devices will be regulare files on a shared directory.
818

    
819
plain
820
    Disk devices will be logical volumes.
821

    
822
drbd
823
    Disk devices will be drbd (version 8.x) on top of lvm volumes.
824

    
825
rbd
826
    Disk devices will be rbd volumes residing inside a RADOS cluster.
827

    
828
blockdev
829
    Disk devices will be adopted pre-existent block devices.
830

    
831
ext
832
    Disk devices will be provided by external shared storage,
833
    through the ExtStorage Interface using ExtStorage providers.
834

    
835
The optional second value of the ``-n (--node)`` is used for the drbd
836
template type and specifies the remote node.
837

    
838
If you do not want gnt-instance to wait for the disk mirror to be
839
synced, use the ``--no-wait-for-sync`` option.
840

    
841
The ``--file-storage-dir`` specifies the relative path under the
842
cluster-wide file storage directory to store file-based disks. It is
843
useful for having different subdirectories for different
844
instances. The full path of the directory where the disk files are
845
stored will consist of cluster-wide file storage directory + optional
846
subdirectory + instance name. Example:
847
``@RPL_FILE_STORAGE_DIR@/mysubdir/instance1.example.com``. This
848
option is only relevant for instances using the file storage backend.
849

    
850
The ``--file-driver`` specifies the driver to use for file-based
851
disks. Note that currently these drivers work with the xen hypervisor
852
only. This option is only relevant for instances using the file
853
storage backend. The available choices are:
854

    
855
loop
856
    Kernel loopback driver. This driver uses loopback devices to
857
    access the filesystem within the file. However, running I/O
858
    intensive applications in your instance using the loop driver
859
    might result in slowdowns. Furthermore, if you use the loopback
860
    driver consider increasing the maximum amount of loopback devices
861
    (on most systems it's 8) using the max\_loop param.
862

    
863
blktap
864
    The blktap driver (for Xen hypervisors). In order to be able to
865
    use the blktap driver you should check if the 'blktapctrl' user
866
    space disk agent is running (usually automatically started via
867
    xend).  This user-level disk I/O interface has the advantage of
868
    better performance. Especially if you use a network file system
869
    (e.g. NFS) to store your instances this is the recommended choice.
870

    
871
blktap2
872
    Analogous to the blktap driver, but used by newer versions of Xen.
873

    
874
If ``--ignore-ipolicy`` is given any instance policy violations occuring
875
during this operation are ignored.
876

    
877
See **ganeti**\(7) for a description of ``--submit`` and other common
878
options.
879

    
880
Example::
881

    
882
    # gnt-instance add -t file --disk 0:size=30g -B maxmem=512 -o debian-etch \
883
      -n node1.example.com --file-storage-dir=mysubdir instance1.example.com
884
    # gnt-instance add -t plain --disk 0:size=30g -B maxmem=1024,minmem=512 \
885
      -o debian-etch -n node1.example.com instance1.example.com
886
    # gnt-instance add -t plain --disk 0:size=30g --disk 1:size=100g,vg=san \
887
      -B maxmem=512 -o debian-etch -n node1.example.com instance1.example.com
888
    # gnt-instance add -t drbd --disk 0:size=30g -B maxmem=512 -o debian-etch \
889
      -n node1.example.com:node2.example.com instance2.example.com
890
    # gnt-instance add -t rbd --disk 0:size=30g -B maxmem=512 -o debian-etch \
891
      -n node1.example.com instance1.example.com
892
    # gnt-instance add -t ext --disk 0:size=30g,provider=pvdr1 -B maxmem=512 \
893
      -o debian-etch -n node1.example.com instance1.example.com
894
    # gnt-instance add -t ext --disk 0:size=30g,provider=pvdr1,param1=val1 \
895
      --disk 1:size=40g,provider=pvdr2,param2=val2,param3=val3 -B maxmem=512 \
896
      -o debian-etch -n node1.example.com instance1.example.com
897

    
898

    
899
BATCH-CREATE
900
^^^^^^^^^^^^
901

    
902
| **batch-create**
903
| [{-I|\--iallocator} *instance allocator*]
904
| {instances\_file.json}
905

    
906
This command (similar to the Ganeti 1.2 **batcher** tool) submits
907
multiple instance creation jobs based on a definition file. This
908
file can contain all options which are valid when adding an instance
909
with the exception of the ``iallocator`` field. The IAllocator is,
910
for optimization purposes, only allowed to be set for the whole batch
911
operation using the ``--iallocator`` parameter.
912

    
913
The instance file must be a valid-formed JSON file, containing an
914
array of dictionaries with instance creation parameters. All parameters
915
(except ``iallocator``) which are valid for the instance creation
916
OP code are allowed. The most important ones are:
917

    
918
instance\_name
919
    The FQDN of the new instance.
920

    
921
disk\_template
922
    The disk template to use for the instance, the same as in the
923
    **add** command.
924

    
925
disks
926
    Array of disk specifications. Each entry describes one disk as a
927
    dictionary of disk parameters.
928

    
929
beparams
930
    A dictionary of backend parameters.
931

    
932
hypervisor
933
    The hypervisor for the instance.
934

    
935
hvparams
936
    A dictionary with the hypervisor options. If not passed, the default
937
    hypervisor options will be inherited.
938

    
939
nics
940
    List of NICs that will be created for the instance. Each entry
941
    should be a dict, with mac, ip, mode and link as possible keys.
942
    Please don't provide the "mac, ip, mode, link" parent keys if you
943
    use this method for specifying NICs.
944

    
945
pnode, snode
946
    The primary and optionally the secondary node to use for the
947
    instance (in case an iallocator script is not used). If those
948
    parameters are given, they have to be given consistently for all
949
    instances in the batch operation.
950

    
951
start
952
    whether to start the instance
953

    
954
ip\_check
955
    Skip the check for already-in-use instance; see the description in
956
    the **add** command for details.
957

    
958
name\_check
959
    Skip the name check for instances; see the description in the
960
    **add** command for details.
961

    
962
file\_storage\_dir, file\_driver
963
    Configuration for the file disk type, see the **add** command for
964
    details.
965

    
966

    
967
A simple definition for one instance can be (with most of the
968
parameters taken from the cluster defaults)::
969

    
970
    [
971
      {
972
        "mode": "create",
973
        "instance_name": "instance1.example.com",
974
        "disk_template": "drbd",
975
        "os_type": "debootstrap",
976
        "disks": [{"size":"1024"}],
977
        "nics": [{}],
978
        "hypervisor": "xen-pvm"
979
      },
980
      {
981
        "mode": "create",
982
        "instance_name": "instance2.example.com",
983
        "disk_template": "drbd",
984
        "os_type": "debootstrap",
985
        "disks": [{"size":"4096", "mode": "rw", "vg": "xenvg"}],
986
        "nics": [{}],
987
        "hypervisor": "xen-hvm",
988
        "hvparams": {"acpi": true},
989
        "beparams": {"maxmem": 512, "minmem": 256}
990
      }
991
    ]
992

    
993
The command will display the job id for each submitted instance, as
994
follows::
995

    
996
    # gnt-instance batch-create instances.json
997
    Submitted jobs 37, 38
998

    
999
REMOVE
1000
^^^^^^
1001

    
1002
**remove** [\--ignore-failures] [\--shutdown-timeout=*N*] [\--submit]
1003
[\--force] {*instance*}
1004

    
1005
Remove an instance. This will remove all data from the instance and
1006
there is *no way back*. If you are not sure if you use an instance
1007
again, use **shutdown** first and leave it in the shutdown state for a
1008
while.
1009

    
1010
The ``--ignore-failures`` option will cause the removal to proceed
1011
even in the presence of errors during the removal of the instance
1012
(e.g. during the shutdown or the disk removal). If this option is not
1013
given, the command will stop at the first error.
1014

    
1015
The ``--shutdown-timeout`` is used to specify how much time to wait
1016
before forcing the shutdown (e.g. ``xm destroy`` in Xen, killing the
1017
kvm process for KVM, etc.). By default two minutes are given to each
1018
instance to stop.
1019

    
1020
The ``--force`` option is used to skip the interactive confirmation.
1021

    
1022
See **ganeti**\(7) for a description of ``--submit`` and other common
1023
options.
1024

    
1025
Example::
1026

    
1027
    # gnt-instance remove instance1.example.com
1028

    
1029

    
1030
LIST
1031
^^^^
1032

    
1033
| **list**
1034
| [\--no-headers] [\--separator=*SEPARATOR*] [\--units=*UNITS*] [-v]
1035
| [{-o|\--output} *[+]FIELD,...*] [\--filter] [instance...]
1036

    
1037
Shows the currently configured instances with memory usage, disk
1038
usage, the node they are running on, and their run status.
1039

    
1040
The ``--no-headers`` option will skip the initial header line. The
1041
``--separator`` option takes an argument which denotes what will be
1042
used between the output fields. Both these options are to help
1043
scripting.
1044

    
1045
The units used to display the numeric values in the output varies,
1046
depending on the options given. By default, the values will be
1047
formatted in the most appropriate unit. If the ``--separator`` option
1048
is given, then the values are shown in mebibytes to allow parsing by
1049
scripts. In both cases, the ``--units`` option can be used to enforce
1050
a given output unit.
1051

    
1052
The ``-v`` option activates verbose mode, which changes the display of
1053
special field states (see **ganeti**\(7)).
1054

    
1055
The ``-o (--output)`` option takes a comma-separated list of output
1056
fields. The available fields and their meaning are:
1057

    
1058
@QUERY_FIELDS_INSTANCE@
1059

    
1060
If the value of the option starts with the character ``+``, the new
1061
field(s) will be added to the default list. This allows one to quickly
1062
see the default list plus a few other fields, instead of retyping the
1063
entire list of fields.
1064

    
1065
There is a subtle grouping about the available output fields: all
1066
fields except for ``oper_state``, ``oper_ram``, ``oper_vcpus`` and
1067
``status`` are configuration value and not run-time values. So if you
1068
don't select any of the these fields, the query will be satisfied
1069
instantly from the cluster configuration, without having to ask the
1070
remote nodes for the data. This can be helpful for big clusters when
1071
you only want some data and it makes sense to specify a reduced set of
1072
output fields.
1073

    
1074
If exactly one argument is given and it appears to be a query filter
1075
(see **ganeti**\(7)), the query result is filtered accordingly. For
1076
ambiguous cases (e.g. a single field name as a filter) the ``--filter``
1077
(``-F``) option forces the argument to be treated as a filter (e.g.
1078
``gnt-instance list -F admin_state``).
1079

    
1080
The default output field list is: ``name``, ``os``, ``pnode``,
1081
``admin_state``, ``oper_state``, ``oper_ram``.
1082

    
1083

    
1084
LIST-FIELDS
1085
^^^^^^^^^^^
1086

    
1087
**list-fields** [field...]
1088

    
1089
Lists available fields for instances.
1090

    
1091

    
1092
INFO
1093
^^^^
1094

    
1095
**info** [-s \| \--static] [\--roman] {\--all \| *instance*}
1096

    
1097
Show detailed information about the given instance(s). This is
1098
different from **list** as it shows detailed data about the instance's
1099
disks (especially useful for the drbd disk template).
1100

    
1101
If the option ``-s`` is used, only information available in the
1102
configuration file is returned, without querying nodes, making the
1103
operation faster.
1104

    
1105
Use the ``--all`` to get info about all instances, rather than
1106
explicitly passing the ones you're interested in.
1107

    
1108
The ``--roman`` option can be used to cause envy among people who like
1109
ancient cultures, but are stuck with non-latin-friendly cluster
1110
virtualization technologies.
1111

    
1112
MODIFY
1113
^^^^^^
1114

    
1115
| **modify**
1116
| [{-H|\--hypervisor-parameters} *HYPERVISOR\_PARAMETERS*]
1117
| [{-B|\--backend-parameters} *BACKEND\_PARAMETERS*]
1118
| [{-m|\--runtime-memory} *SIZE*]
1119
| [\--net add[:options...] \|
1120
|  \--net [*N*:]add[,options...] \|
1121
|  \--net [*ID*:]remove \|
1122
|  \--net *ID*:modify[,options...]]
1123
| [\--disk add:size=*SIZE*[,options...] \|
1124
|  \--disk *N*:add,size=*SIZE*[,options...] \|
1125
|  \--disk *N*:add,size=*SIZE*,provider=*PROVIDER*[,options...][,param=*value*... ] \|
1126
|  \--disk *ID*:modify[,options...]
1127
|  \--disk [*ID*:]remove]
1128
| [{-t|\--disk-template} plain | {-t|\--disk-template} drbd -n *new_secondary*] [\--no-wait-for-sync]
1129
| [\--new-primary=*node*]
1130
| [\--os-type=*OS* [\--force-variant]]
1131
| [{-O|\--os-parameters} *param*=*value*... ]
1132
| [\--offline \| \--online]
1133
| [\--submit]
1134
| [\--ignore-ipolicy]
1135
| [\--hotplug]
1136
| [\--hotplug-if-possible]
1137
| {*instance*}
1138

    
1139
Modifies the memory size, number of vcpus, ip address, MAC address
1140
and/or NIC parameters for an instance. It can also add and remove
1141
disks and NICs to/from the instance. Note that you need to give at
1142
least one of the arguments, otherwise the command complains.
1143

    
1144
The ``-H (--hypervisor-parameters)``, ``-B (--backend-parameters)``
1145
and ``-O (--os-parameters)`` options specifies hypervisor, backend and
1146
OS parameter options in the form of name=value[,...]. For details
1147
which options can be specified, see the **add** command.
1148

    
1149
The ``-t (--disk-template)`` option will change the disk template of
1150
the instance.  Currently only conversions between the plain and drbd
1151
disk templates are supported, and the instance must be stopped before
1152
attempting the conversion. When changing from the plain to the drbd
1153
disk template, a new secondary node must be specified via the ``-n``
1154
option. The option ``--no-wait-for-sync`` can be used when converting
1155
to the ``drbd`` template in order to make the instance available for
1156
startup before DRBD has finished resyncing.
1157

    
1158
The ``-m (--runtime-memory)`` option will change an instance's runtime
1159
memory to the given size (in MB if a different suffix is not specified),
1160
by ballooning it up or down to the new value.
1161

    
1162
The ``--disk add:size=*SIZE*,[options..]`` option adds a disk to the
1163
instance, and ``--disk *N*:add:size=*SIZE*,[options..]`` will add a disk
1164
to the the instance at a specific index. The available options are the
1165
same as in the **add** command(``mode``, ``name``, ``vg``, ``metavg``).
1166
When adding an ExtStorage disk the ``provider=*PROVIDER*`` option is
1167
also mandatory and specifies the ExtStorage provider. Also, for
1168
ExtStorage disks arbitrary parameters can be passed as additional comma
1169
separated options, same as in the **add** command. -The ``--disk remove``
1170
option will remove the last disk of the instance. Use
1171
``--disk `` *ID*``:remove`` to remove a disk by its identifier.  *ID*
1172
can be the index of the disk, the disks's name or the disks's UUID.  The
1173
``--disk *ID*:modify[,options...]`` wil change the options of the disk.
1174
Available options are:
1175

    
1176
mode
1177
  The access mode. Either ``ro`` (read-only) or the default ``rw`` (read-write).
1178

    
1179
name
1180
   this option specifies a name for the disk, which can be used as a disk
1181
   identifier. An instance can not have two disks with the same name.
1182

    
1183
The ``--net *N*:add[,options..]`` will add a new network interface to
1184
the instance. The available options are the same as in the **add**
1185
command (``mac``, ``ip``, ``link``, ``mode``, ``network``). The
1186
``--net *ID*,remove`` will remove the intances' NIC with *ID* identifier,
1187
which can be the index of the NIC, the NIC's name or the NIC's UUID.
1188
The ``--net *ID*:modify[,options..]`` option will change the parameters of
1189
the instance network interface with the *ID* identifier.
1190

    
1191
The option ``-o (--os-type)`` will change the OS name for the instance
1192
(without reinstallation). In case an OS variant is specified that is
1193
not found, then by default the modification is refused, unless
1194
``--force-variant`` is passed. An invalid OS will also be refused,
1195
unless the ``--force`` option is given.
1196

    
1197
The option ``--new-primary`` will set the new primary node of an instance
1198
assuming the disks have already been moved manually. Unless the ``--force``
1199
option is given, it is verified that the instance is no longer running
1200
on its current primary node.
1201

    
1202
The ``--online`` and ``--offline`` options are used to transition an
1203
instance into and out of the ``offline`` state. An instance can be
1204
turned offline only if it was previously down. The ``--online`` option
1205
fails if the instance was not in the ``offline`` state, otherwise it
1206
changes instance's state to ``down``. These modifications take effect
1207
immediately.
1208

    
1209
If ``--ignore-ipolicy`` is given any instance policy violations occuring
1210
during this operation are ignored.
1211

    
1212
If ``--hotplug`` is given any disk and NIC modifications will take
1213
effect without the need of actual reboot. Please note that this feature
1214
is currently supported only for KVM hypervisor and there are some
1215
restrictions: a) KVM versions >= 1.0 support it b) instances with chroot
1216
or uid pool security model do not support disk hotplug c) RBD disks with
1217
userspace access mode can not be hotplugged (yet) d) if hotplug fails
1218
(for any reason) a warning is printed but execution is continued e)
1219
for existing NIC modification interactive verification is needed unless
1220
``--force`` option is passed.
1221

    
1222
If ``--hotplug-if-possible`` is given then ganeti won't abort in case
1223
hotplug is not supported. It will continue execution and modification
1224
will take place after reboot. This covers use cases where instances are
1225
not running or hypervisor is not KVM.
1226

    
1227
See **ganeti**\(7) for a description of ``--submit`` and other common
1228
options.
1229

    
1230
Most of the changes take effect at the next restart. If the instance is
1231
running, there is no effect on the instance.
1232

    
1233

    
1234
SNAPSHOT
1235
^^^^^^^^
1236

    
1237
| **snapshot**
1238
| {\--disk=*ID*:snapshot_name=*VAL*
1239
| [\--submit]
1240
| {*instance*}
1241

    
1242
This only works for instances with ext disk template. It eventualla runs
1243
the snapshot script of the corresponding extstorage provider.
1244
The ``--disk 0:snapshot_name=snap1`` will take snapshot of the first disk
1245
by exporting snapshot name (via VOL_SNAPSHOT_NAME) and disk related info
1246
to the script environment. *ID* can be a disk index, name or UUID.
1247

    
1248

    
1249
REINSTALL
1250
^^^^^^^^^
1251

    
1252
| **reinstall** [{-o|\--os-type} *os-type*] [\--select-os] [-f *force*]
1253
| [\--force-multiple]
1254
| [\--instance \| \--node \| \--primary \| \--secondary \| \--all]
1255
| [{-O|\--os-parameters} *OS\_PARAMETERS*] [\--submit] {*instance*...}
1256

    
1257
Reinstalls the operating system on the given instance(s). The
1258
instance(s) must be stopped when running this command. If the ``-o
1259
(--os-type)`` is specified, the operating system is changed.
1260

    
1261
The ``--select-os`` option switches to an interactive OS reinstall.
1262
The user is prompted to select the OS template from the list of
1263
available OS templates. OS parameters can be overridden using ``-O
1264
(--os-parameters)`` (more documentation for this option under the
1265
**add** command).
1266

    
1267
Since this is a potentially dangerous command, the user will be
1268
required to confirm this action, unless the ``-f`` flag is passed.
1269
When multiple instances are selected (either by passing multiple
1270
arguments or by using the ``--node``, ``--primary``, ``--secondary``
1271
or ``--all`` options), the user must pass the ``--force-multiple``
1272
options to skip the interactive confirmation.
1273

    
1274
See **ganeti**\(7) for a description of ``--submit`` and other common
1275
options.
1276

    
1277
RENAME
1278
^^^^^^
1279

    
1280
| **rename** [\--no-ip-check] [\--no-name-check] [\--submit]
1281
| {*instance*} {*new\_name*}
1282

    
1283
Renames the given instance. The instance must be stopped when running
1284
this command. The requirements for the new name are the same as for
1285
adding an instance: the new name must be resolvable and the IP it
1286
resolves to must not be reachable (in order to prevent duplicate IPs
1287
the next time the instance is started). The IP test can be skipped if
1288
the ``--no-ip-check`` option is passed.
1289

    
1290
Note that you can rename an instance to its same name, to force
1291
re-executing the os-specific rename script for that instance, if
1292
needed.
1293

    
1294
The ``--no-name-check`` skips the check for the new instance name via
1295
the resolver (e.g. in DNS or /etc/hosts, depending on your setup) and
1296
that the resolved name matches the provided name. Since the name check
1297
is used to compute the IP address, if you pass this option you must also
1298
pass the ``--no-ip-check`` option.
1299

    
1300
See **ganeti**\(7) for a description of ``--submit`` and other common
1301
options.
1302

    
1303
Starting/stopping/connecting to console
1304
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1305

    
1306
STARTUP
1307
^^^^^^^
1308

    
1309
| **startup**
1310
| [\--force] [\--ignore-offline]
1311
| [\--force-multiple] [\--no-remember]
1312
| [\--instance \| \--node \| \--primary \| \--secondary \| \--all \|
1313
| \--tags \| \--node-tags \| \--pri-node-tags \| \--sec-node-tags]
1314
| [{-H|\--hypervisor-parameters} ``key=value...``]
1315
| [{-B|\--backend-parameters} ``key=value...``]
1316
| [\--submit] [\--paused]
1317
| {*name*...}
1318

    
1319
Starts one or more instances, depending on the following options.  The
1320
four available modes are:
1321

    
1322
\--instance
1323
    will start the instances given as arguments (at least one argument
1324
    required); this is the default selection
1325

    
1326
\--node
1327
    will start the instances who have the given node as either primary
1328
    or secondary
1329

    
1330
\--primary
1331
    will start all instances whose primary node is in the list of nodes
1332
    passed as arguments (at least one node required)
1333

    
1334
\--secondary
1335
    will start all instances whose secondary node is in the list of
1336
    nodes passed as arguments (at least one node required)
1337

    
1338
\--all
1339
    will start all instances in the cluster (no arguments accepted)
1340

    
1341
\--tags
1342
    will start all instances in the cluster with the tags given as
1343
    arguments
1344

    
1345
\--node-tags
1346
    will start all instances in the cluster on nodes with the tags
1347
    given as arguments
1348

    
1349
\--pri-node-tags
1350
    will start all instances in the cluster on primary nodes with the
1351
    tags given as arguments
1352

    
1353
\--sec-node-tags
1354
    will start all instances in the cluster on secondary nodes with the
1355
    tags given as arguments
1356

    
1357
Note that although you can pass more than one selection option, the
1358
last one wins, so in order to guarantee the desired result, don't pass
1359
more than one such option.
1360

    
1361
Use ``--force`` to start even if secondary disks are failing.
1362
``--ignore-offline`` can be used to ignore offline primary nodes and
1363
mark the instance as started even if the primary is not available.
1364

    
1365
The ``--force-multiple`` will skip the interactive confirmation in the
1366
case the more than one instance will be affected.
1367

    
1368
The ``--no-remember`` option will perform the startup but not change
1369
the state of the instance in the configuration file (if it was stopped
1370
before, Ganeti will still think it needs to be stopped). This can be
1371
used for testing, or for a one shot-start where you don't want the
1372
watcher to restart the instance if it crashes.
1373

    
1374
The ``-H (--hypervisor-parameters)`` and ``-B (--backend-parameters)``
1375
options specify temporary hypervisor and backend parameters that can
1376
be used to start an instance with modified parameters. They can be
1377
useful for quick testing without having to modify an instance back and
1378
forth, e.g.::
1379

    
1380
    # gnt-instance start -H kernel_args="single" instance1
1381
    # gnt-instance start -B maxmem=2048 instance2
1382

    
1383

    
1384
The first form will start the instance instance1 in single-user mode,
1385
and the instance instance2 with 2GB of RAM (this time only, unless
1386
that is the actual instance memory size already). Note that the values
1387
override the instance parameters (and not extend them): an instance
1388
with "kernel\_args=ro" when started with -H kernel\_args=single will
1389
result in "single", not "ro single".
1390

    
1391
The ``--paused`` option is only valid for Xen and kvm hypervisors.  This
1392
pauses the instance at the start of bootup, awaiting ``gnt-instance
1393
console`` to unpause it, allowing the entire boot process to be
1394
monitored for debugging.
1395

    
1396
See **ganeti**\(7) for a description of ``--submit`` and other common
1397
options.
1398

    
1399
Example::
1400

    
1401
    # gnt-instance start instance1.example.com
1402
    # gnt-instance start --node node1.example.com node2.example.com
1403
    # gnt-instance start --all
1404

    
1405

    
1406
SHUTDOWN
1407
^^^^^^^^
1408

    
1409
| **shutdown**
1410
| [\--timeout=*N*]
1411
| [\--force] [\--force-multiple] [\--ignore-offline] [\--no-remember]
1412
| [\--instance \| \--node \| \--primary \| \--secondary \| \--all \|
1413
| \--tags \| \--node-tags \| \--pri-node-tags \| \--sec-node-tags]
1414
| [\--submit]
1415
| {*name*...}
1416

    
1417
Stops one or more instances. If the instance cannot be cleanly stopped
1418
during a hardcoded interval (currently 2 minutes), it will forcibly
1419
stop the instance (equivalent to switching off the power on a physical
1420
machine).
1421

    
1422
The ``--timeout`` is used to specify how much time to wait before
1423
forcing the shutdown (e.g. ``xm destroy`` in Xen, killing the kvm
1424
process for KVM, etc.). By default two minutes are given to each
1425
instance to stop.
1426

    
1427
The ``--instance``, ``--node``, ``--primary``, ``--secondary``,
1428
``--all``, ``--tags``, ``--node-tags``, ``--pri-node-tags`` and
1429
``--sec-node-tags`` options are similar as for the **startup** command
1430
and they influence the actual instances being shutdown.
1431

    
1432
``--ignore-offline`` can be used to ignore offline primary nodes and
1433
force the instance to be marked as stopped. This option should be used
1434
with care as it can lead to an inconsistent cluster state.
1435

    
1436
Use ``--force`` to be able to shutdown an instance even when it's marked
1437
as offline. This is useful is an offline instance ends up in the
1438
``ERROR_up`` state, for example.
1439

    
1440
The ``--no-remember`` option will perform the shutdown but not change
1441
the state of the instance in the configuration file (if it was running
1442
before, Ganeti will still thinks it needs to be running). This can be
1443
useful for a cluster-wide shutdown, where some instances are marked as
1444
up and some as down, and you don't want to change the running state:
1445
you just need to disable the watcher, shutdown all instances with
1446
``--no-remember``, and when the watcher is activated again it will
1447
restore the correct runtime state for all instances.
1448

    
1449
See **ganeti**\(7) for a description of ``--submit`` and other common
1450
options.
1451

    
1452
Example::
1453

    
1454
    # gnt-instance shutdown instance1.example.com
1455
    # gnt-instance shutdown --all
1456

    
1457

    
1458
REBOOT
1459
^^^^^^
1460

    
1461
| **reboot**
1462
| [{-t|\--type} *REBOOT-TYPE*]
1463
| [\--ignore-secondaries]
1464
| [\--shutdown-timeout=*N*]
1465
| [\--force-multiple]
1466
| [\--instance \| \--node \| \--primary \| \--secondary \| \--all \|
1467
| \--tags \| \--node-tags \| \--pri-node-tags \| \--sec-node-tags]
1468
| [\--submit]
1469
| [*name*...]
1470

    
1471
Reboots one or more instances. The type of reboot depends on the value
1472
of ``-t (--type)``. A soft reboot does a hypervisor reboot, a hard reboot
1473
does a instance stop, recreates the hypervisor config for the instance
1474
and starts the instance. A full reboot does the equivalent of
1475
**gnt-instance shutdown && gnt-instance startup**.  The default is
1476
hard reboot.
1477

    
1478
For the hard reboot the option ``--ignore-secondaries`` ignores errors
1479
for the secondary node while re-assembling the instance disks.
1480

    
1481
The ``--instance``, ``--node``, ``--primary``, ``--secondary``,
1482
``--all``, ``--tags``, ``--node-tags``, ``--pri-node-tags`` and
1483
``--sec-node-tags`` options are similar as for the **startup** command
1484
and they influence the actual instances being rebooted.
1485

    
1486
The ``--shutdown-timeout`` is used to specify how much time to wait
1487
before forcing the shutdown (xm destroy in xen, killing the kvm
1488
process, for kvm). By default two minutes are given to each instance
1489
to stop.
1490

    
1491
The ``--force-multiple`` will skip the interactive confirmation in the
1492
case the more than one instance will be affected.
1493

    
1494
See **ganeti**\(7) for a description of ``--submit`` and other common
1495
options.
1496

    
1497
Example::
1498

    
1499
    # gnt-instance reboot instance1.example.com
1500
    # gnt-instance reboot --type=full instance1.example.com
1501

    
1502

    
1503
CONSOLE
1504
^^^^^^^
1505

    
1506
**console** [\--show-cmd] {*instance*}
1507

    
1508
Connects to the console of the given instance. If the instance is not
1509
up, an error is returned. Use the ``--show-cmd`` option to display the
1510
command instead of executing it.
1511

    
1512
For HVM instances, this will attempt to connect to the serial console
1513
of the instance. To connect to the virtualized "physical" console of a
1514
HVM instance, use a VNC client with the connection info from the
1515
**info** command.
1516

    
1517
For Xen/kvm instances, if the instance is paused, this attempts to
1518
unpause the instance after waiting a few seconds for the connection to
1519
the console to be made.
1520

    
1521
Example::
1522

    
1523
    # gnt-instance console instance1.example.com
1524

    
1525

    
1526
Disk management
1527
~~~~~~~~~~~~~~~
1528

    
1529
REPLACE-DISKS
1530
^^^^^^^^^^^^^
1531

    
1532
**replace-disks** [\--submit] [\--early-release] [\--ignore-ipolicy] {-p}
1533
[\--disks *idx*] {*instance*}
1534

    
1535
**replace-disks** [\--submit] [\--early-release] [\--ignore-ipolicy] {-s}
1536
[\--disks *idx*] {*instance*}
1537

    
1538
**replace-disks** [\--submit] [\--early-release] [\--ignore-ipolicy]
1539
{{-I\|\--iallocator} *name* \| {{-n|\--new-secondary} *node* } {*instance*}
1540

    
1541
**replace-disks** [\--submit] [\--early-release] [\--ignore-ipolicy]
1542
{-a\|\--auto} {*instance*}
1543

    
1544
This command is a generalized form for replacing disks. It is
1545
currently only valid for the mirrored (DRBD) disk template.
1546

    
1547
The first form (when passing the ``-p`` option) will replace the disks
1548
on the primary, while the second form (when passing the ``-s`` option
1549
will replace the disks on the secondary node. For these two cases (as
1550
the node doesn't change), it is possible to only run the replace for a
1551
subset of the disks, using the option ``--disks`` which takes a list
1552
of comma-delimited disk indices (zero-based), e.g. 0,2 to replace only
1553
the first and third disks.
1554

    
1555
The third form (when passing either the ``--iallocator`` or the
1556
``--new-secondary`` option) is designed to change secondary node of the
1557
instance. Specifying ``--iallocator`` makes the new secondary be
1558
selected automatically by the specified allocator plugin (use ``.`` to
1559
indicate the default allocator), otherwise the new secondary node will
1560
be the one chosen manually via the ``--new-secondary`` option.
1561

    
1562
Note that it is not possible to select an offline or drained node as a
1563
new secondary.
1564

    
1565
The fourth form (when using ``--auto``) will automatically determine
1566
which disks of an instance are faulty and replace them within the same
1567
node. The ``--auto`` option works only when an instance has only
1568
faulty disks on either the primary or secondary node; it doesn't work
1569
when both sides have faulty disks.
1570

    
1571
The ``--early-release`` changes the code so that the old storage on
1572
secondary node(s) is removed early (before the resync is completed)
1573
and the internal Ganeti locks for the current (and new, if any)
1574
secondary node are also released, thus allowing more parallelism in
1575
the cluster operation. This should be used only when recovering from a
1576
disk failure on the current secondary (thus the old storage is already
1577
broken) or when the storage on the primary node is known to be fine
1578
(thus we won't need the old storage for potential recovery).
1579

    
1580
The ``--ignore-ipolicy`` let the command ignore instance policy
1581
violations if replace-disks changes groups and the instance would
1582
violate the new groups instance policy.
1583

    
1584
See **ganeti**\(7) for a description of ``--submit`` and other common
1585
options.
1586

    
1587
ACTIVATE-DISKS
1588
^^^^^^^^^^^^^^
1589

    
1590
**activate-disks** [\--submit] [\--ignore-size] [\--wait-for-sync] {*instance*}
1591

    
1592
Activates the block devices of the given instance. If successful, the
1593
command will show the location and name of the block devices::
1594

    
1595
    node1.example.com:disk/0:/dev/drbd0
1596
    node1.example.com:disk/1:/dev/drbd1
1597

    
1598

    
1599
In this example, *node1.example.com* is the name of the node on which
1600
the devices have been activated. The *disk/0* and *disk/1* are the
1601
Ganeti-names of the instance disks; how they are visible inside the
1602
instance is hypervisor-specific. */dev/drbd0* and */dev/drbd1* are the
1603
actual block devices as visible on the node.
1604

    
1605
The ``--ignore-size`` option can be used to activate disks ignoring
1606
the currently configured size in Ganeti. This can be used in cases
1607
where the configuration has gotten out of sync with the real-world
1608
(e.g. after a partially-failed grow-disk operation or due to rounding
1609
in LVM devices). This should not be used in normal cases, but only
1610
when activate-disks fails without it.
1611

    
1612
The ``--wait-for-sync`` option will ensure that the command returns only
1613
after the instance's disks are synchronised (mostly for DRBD); this can
1614
be useful to ensure consistency, as otherwise there are no commands that
1615
can wait until synchronisation is done. However when passing this
1616
option, the command will have additional output, making it harder to
1617
parse the disk information.
1618

    
1619
Note that it is safe to run this command while the instance is already
1620
running.
1621

    
1622
See **ganeti**\(7) for a description of ``--submit`` and other common
1623
options.
1624

    
1625
DEACTIVATE-DISKS
1626
^^^^^^^^^^^^^^^^
1627

    
1628
**deactivate-disks** [-f] [\--submit] {*instance*}
1629

    
1630
De-activates the block devices of the given instance. Note that if you
1631
run this command for an instance with a drbd disk template, while it
1632
is running, it will not be able to shutdown the block devices on the
1633
primary node, but it will shutdown the block devices on the secondary
1634
nodes, thus breaking the replication.
1635

    
1636
The ``-f``/``--force`` option will skip checks that the instance is
1637
down; in case the hypervisor is confused and we can't talk to it,
1638
normally Ganeti will refuse to deactivate the disks, but with this
1639
option passed it will skip this check and directly try to deactivate
1640
the disks. This can still fail due to the instance actually running or
1641
other issues.
1642

    
1643
See **ganeti**\(7) for a description of ``--submit`` and other common
1644
options.
1645

    
1646
GROW-DISK
1647
^^^^^^^^^
1648

    
1649
| **grow-disk** [\--no-wait-for-sync] [\--submit] [\--absolute]
1650
| {*instance*} {*disk*} {*amount*}
1651

    
1652
Grows an instance's disk. This is only possible for instances having a
1653
plain, drbd, file, sharedfile, rbd or ext disk template. For the ext
1654
template to work, the ExtStorage provider should also support growing.
1655
This means having a ``grow`` script that actually grows the volume of
1656
the external shared storage.
1657

    
1658
Note that this command only change the block device size; it will not
1659
grow the actual filesystems, partitions, etc. that live on that
1660
disk. Usually, you will need to:
1661

    
1662
#. use **gnt-instance grow-disk**
1663

    
1664
#. reboot the instance (later, at a convenient time)
1665

    
1666
#. use a filesystem resizer, such as **ext2online**\(8) or
1667
   **xfs\_growfs**\(8) to resize the filesystem, or use **fdisk**\(8) to
1668
   change the partition table on the disk
1669

    
1670
The *disk* argument is the index of the instance disk to grow. The
1671
*amount* argument is given as a number which can have a suffix (like the
1672
disk size in instance create); if the suffix is missing, the value will
1673
be interpreted as mebibytes.
1674

    
1675
By default, the *amount* value represents the desired increase in the
1676
disk size (e.g. an amount of 1G will take a disk of size 3G to 4G). If
1677
the optional ``--absolute`` parameter is passed, then the *amount*
1678
argument doesn't represent the delta, but instead the desired final disk
1679
size (e.g. an amount of 8G will take a disk of size 4G to 8G).
1680

    
1681
For instances with a drbd template, note that the disk grow operation
1682
might complete on one node but fail on the other; this will leave the
1683
instance with different-sized LVs on the two nodes, but this will not
1684
create problems (except for unused space).
1685

    
1686
If you do not want gnt-instance to wait for the new disk region to be
1687
synced, use the ``--no-wait-for-sync`` option.
1688

    
1689
See **ganeti**\(7) for a description of ``--submit`` and other common
1690
options.
1691

    
1692
Example (increase the first disk for instance1 by 16GiB)::
1693

    
1694
    # gnt-instance grow-disk instance1.example.com 0 16g
1695

    
1696
Example for increasing the disk size to a certain size::
1697

    
1698
   # gnt-instance grow-disk --absolute instance1.example.com 0 32g
1699

    
1700
Also note that disk shrinking is not supported; use **gnt-backup
1701
export** and then **gnt-backup import** to reduce the disk size of an
1702
instance.
1703

    
1704
RECREATE-DISKS
1705
^^^^^^^^^^^^^^
1706

    
1707
| **recreate-disks** [\--submit]
1708
| [{-n node1:[node2] \| {-I\|\--iallocator *name*}}]
1709
| [\--disk=*N*[:[size=*VAL*][,mode=*ro\|rw*]]] {*instance*}
1710

    
1711
Recreates all or a subset of disks of the given instance.
1712

    
1713
Note that this functionality should only be used for missing disks; if
1714
any of the given disks already exists, the operation will fail.  While
1715
this is suboptimal, recreate-disks should hopefully not be needed in
1716
normal operation and as such the impact of this is low.
1717

    
1718
If only a subset should be recreated, any number of ``disk`` options can
1719
be specified. It expects a disk index and an optional list of disk
1720
parameters to change. Only ``size`` and ``mode`` can be changed while
1721
recreating disks. To recreate all disks while changing parameters on
1722
a subset only, a ``--disk`` option must be given for every disk of the
1723
instance.
1724

    
1725
Optionally the instance's disks can be recreated on different
1726
nodes. This can be useful if, for example, the original nodes of the
1727
instance have gone down (and are marked offline), so we can't recreate
1728
on the same nodes. To do this, pass the new node(s) via ``-n`` option,
1729
with a syntax similar to the **add** command. The number of nodes
1730
passed must equal the number of nodes that the instance currently
1731
has. Note that changing nodes is only allowed when all disks are
1732
replaced, e.g. when no ``--disk`` option is passed.
1733

    
1734
Another method of choosing which nodes to place the instance on is by
1735
using the specified iallocator, passing the ``--iallocator`` option.
1736
The primary and secondary nodes will be chosen by the specified
1737
iallocator plugin, or by the default allocator if ``.`` is specified.
1738

    
1739
See **ganeti**\(7) for a description of ``--submit`` and other common
1740
options.
1741

    
1742
Recovery/moving
1743
~~~~~~~~~~~~~~~
1744

    
1745
FAILOVER
1746
^^^^^^^^
1747

    
1748
| **failover** [-f] [\--ignore-consistency] [\--ignore-ipolicy]
1749
| [\--shutdown-timeout=*N*]
1750
| [{-n|\--target-node} *node* \| {-I|\--iallocator} *name*]
1751
| [\--submit] [\--cleanup]
1752
| {*instance*}
1753

    
1754
Failover will stop the instance (if running), change its primary node,
1755
and if it was originally running it will start it again (on the new
1756
primary). This works for instances with drbd template (in which case you
1757
can only fail to the secondary node) and for externally mirrored
1758
templates (sharedfile, blockdev, rbd and ext) (in which case you can
1759
fail to any other node).
1760

    
1761
If the instance's disk template is of type sharedfile, blockdev, rbd or
1762
ext, then you can explicitly specify the target node (which can be any
1763
node) using the ``-n`` or ``--target-node`` option, or specify an
1764
iallocator plugin using the ``-I`` or ``--iallocator`` option. If you
1765
omit both, the default iallocator will be used to specify the target
1766
node.
1767

    
1768
If the instance's disk template is of type drbd, the target node is
1769
automatically selected as the drbd's secondary node. Changing the
1770
secondary node is possible with a replace-disks operation.
1771

    
1772
Normally the failover will check the consistency of the disks before
1773
failing over the instance. If you are trying to migrate instances off
1774
a dead node, this will fail. Use the ``--ignore-consistency`` option
1775
for this purpose. Note that this option can be dangerous as errors in
1776
shutting down the instance will be ignored, resulting in possibly
1777
having the instance running on two machines in parallel (on
1778
disconnected DRBD drives).
1779

    
1780
The ``--shutdown-timeout`` is used to specify how much time to wait
1781
before forcing the shutdown (xm destroy in xen, killing the kvm
1782
process, for kvm). By default two minutes are given to each instance
1783
to stop.
1784

    
1785
If ``--ignore-ipolicy`` is given any instance policy violations occuring
1786
during this operation are ignored.
1787

    
1788
If the ``--cleanup`` option is passed, the operation changes from
1789
performin a failover to attempting recovery from a failed previous failover.
1790
In this mode, Ganeti checks if the instance runs on the correct node (and
1791
updates its configuration if not) and ensures the instances' disks
1792
are configured correctly.
1793

    
1794
See **ganeti**\(7) for a description of ``--submit`` and other common
1795
options.
1796

    
1797
Example::
1798

    
1799
    # gnt-instance failover instance1.example.com
1800

    
1801
For externally mirrored templates also ``-n`` is available::
1802

    
1803
    # gnt-instance failover -n node3.example.com instance1.example.com
1804

    
1805

    
1806
MIGRATE
1807
^^^^^^^
1808

    
1809
| **migrate** [-f] [\--allow-failover] [\--non-live]
1810
| [\--migration-mode=live\|non-live] [\--ignore-ipolicy]
1811
| [\--no-runtime-changes] [\--submit]
1812
| [{-n|\--target-node} *node* \| {-I|\--iallocator} *name*] {*instance*}
1813

    
1814
| **migrate** [-f] \--cleanup [\--submit] {*instance*}
1815

    
1816
Migrate will move the instance to its secondary node without shutdown.
1817
As with failover, it works for instances having the drbd disk template
1818
or an externally mirrored disk template type such as sharedfile,
1819
blockdev, rbd or ext.
1820

    
1821
If the instance's disk template is of type sharedfile, blockdev, rbd or
1822
ext, then you can explicitly specify the target node (which can be any
1823
node) using the ``-n`` or ``--target-node`` option, or specify an
1824
iallocator plugin using the ``-I`` or ``--iallocator`` option. If you
1825
omit both, the default iallocator will be used to specify the target
1826
node.  Alternatively, the default iallocator can be requested by
1827
specifying ``.`` as the name of the plugin.
1828

    
1829
If the instance's disk template is of type drbd, the target node is
1830
automatically selected as the drbd's secondary node. Changing the
1831
secondary node is possible with a replace-disks operation.
1832

    
1833
The migration command needs a perfectly healthy instance for drbd
1834
instances, as we rely on the dual-master capability of drbd8 and the
1835
disks of the instance are not allowed to be degraded.
1836

    
1837
The ``--non-live`` and ``--migration-mode=non-live`` options will
1838
switch (for the hypervisors that support it) between a "fully live"
1839
(i.e. the interruption is as minimal as possible) migration and one in
1840
which the instance is frozen, its state saved and transported to the
1841
remote node, and then resumed there. This all depends on the
1842
hypervisor support for two different methods. In any case, it is not
1843
an error to pass this parameter (it will just be ignored if the
1844
hypervisor doesn't support it). The option ``--migration-mode=live``
1845
option will request a fully-live migration. The default, when neither
1846
option is passed, depends on the hypervisor parameters (and can be
1847
viewed with the **gnt-cluster info** command).
1848

    
1849
If the ``--cleanup`` option is passed, the operation changes from
1850
migration to attempting recovery from a failed previous migration. In
1851
this mode, Ganeti checks if the instance runs on the correct node (and
1852
updates its configuration if not) and ensures the instances' disks
1853
are configured correctly. In this mode, the ``--non-live`` option is
1854
ignored.
1855

    
1856
The option ``-f`` will skip the prompting for confirmation.
1857

    
1858
If ``--allow-failover`` is specified it tries to fallback to failover if
1859
it already can determine that a migration won't work (e.g. if the
1860
instance is shut down). Please note that the fallback will not happen
1861
during execution. If a migration fails during execution it still fails.
1862

    
1863
If ``--ignore-ipolicy`` is given any instance policy violations occuring
1864
during this operation are ignored.
1865

    
1866
The ``--no-runtime-changes`` option forbids migrate to alter an
1867
instance's runtime before migrating it (eg. ballooning an instance
1868
down because the target node doesn't have enough available memory).
1869

    
1870
If an instance has the backend parameter ``always_failover`` set to
1871
true, then the migration is automatically converted into a failover.
1872

    
1873
See **ganeti**\(7) for a description of ``--submit`` and other common
1874
options.
1875

    
1876
Example (and expected output)::
1877

    
1878
    # gnt-instance migrate instance1
1879
    Instance instance1 will be migrated. Note that migration
1880
    might impact the instance if anything goes wrong (e.g. due to bugs in
1881
    the hypervisor). Continue?
1882
    y/[n]/?: y
1883
    Migrating instance instance1.example.com
1884
    * checking disk consistency between source and target
1885
    * switching node node2.example.com to secondary mode
1886
    * changing into standalone mode
1887
    * changing disks into dual-master mode
1888
    * wait until resync is done
1889
    * preparing node2.example.com to accept the instance
1890
    * migrating instance to node2.example.com
1891
    * switching node node1.example.com to secondary mode
1892
    * wait until resync is done
1893
    * changing into standalone mode
1894
    * changing disks into single-master mode
1895
    * wait until resync is done
1896
    * done
1897
    #
1898

    
1899

    
1900
MOVE
1901
^^^^
1902

    
1903
| **move** [-f] [\--ignore-consistency]
1904
| [-n *node*] [\--shutdown-timeout=*N*] [\--submit] [\--ignore-ipolicy]
1905
| {*instance*}
1906

    
1907
Move will move the instance to an arbitrary node in the cluster. This
1908
works only for instances having a plain or file disk template.
1909

    
1910
Note that since this operation is done via data copy, it will take a
1911
long time for big disks (similar to replace-disks for a drbd
1912
instance).
1913

    
1914
The ``--shutdown-timeout`` is used to specify how much time to wait
1915
before forcing the shutdown (e.g. ``xm destroy`` in XEN, killing the
1916
kvm process for KVM, etc.). By default two minutes are given to each
1917
instance to stop.
1918

    
1919
The ``--ignore-consistency`` option will make Ganeti ignore any errors
1920
in trying to shutdown the instance on its node; useful if the
1921
hypervisor is broken and you want to recover the data.
1922

    
1923
If ``--ignore-ipolicy`` is given any instance policy violations occuring
1924
during this operation are ignored.
1925

    
1926
See **ganeti**\(7) for a description of ``--submit`` and other common
1927
options.
1928

    
1929
Example::
1930

    
1931
    # gnt-instance move -n node3.example.com instance1.example.com
1932

    
1933

    
1934
CHANGE-GROUP
1935
^^^^^^^^^^^^
1936

    
1937
| **change-group** [\--submit]
1938
| [\--iallocator *NAME*] [\--to *GROUP*...] {*instance*}
1939

    
1940
This command moves an instance to another node group. The move is
1941
calculated by an iallocator, either given on the command line or as a
1942
cluster default.
1943

    
1944
If no specific destination groups are specified using ``--to``, all
1945
groups except the one containing the instance are considered.
1946

    
1947
See **ganeti**\(7) for a description of ``--submit`` and other common
1948
options.
1949

    
1950
Example::
1951

    
1952
    # gnt-instance change-group -I hail --to rack2 inst1.example.com
1953

    
1954

    
1955
Tags
1956
~~~~
1957

    
1958
ADD-TAGS
1959
^^^^^^^^
1960

    
1961
**add-tags** [\--from *file*] {*instancename*} {*tag*...}
1962

    
1963
Add tags to the given instance. If any of the tags contains invalid
1964
characters, the entire operation will abort.
1965

    
1966
If the ``--from`` option is given, the list of tags will be extended
1967
with the contents of that file (each line becomes a tag).  In this
1968
case, there is not need to pass tags on the command line (if you do,
1969
both sources will be used). A file name of ``-`` will be interpreted
1970
as stdin.
1971

    
1972
LIST-TAGS
1973
^^^^^^^^^
1974

    
1975
**list-tags** {*instancename*}
1976

    
1977
List the tags of the given instance.
1978

    
1979
REMOVE-TAGS
1980
^^^^^^^^^^^
1981

    
1982
**remove-tags** [\--from *file*] {*instancename*} {*tag*...}
1983

    
1984
Remove tags from the given instance. If any of the tags are not
1985
existing on the node, the entire operation will abort.
1986

    
1987
If the ``--from`` option is given, the list of tags to be removed will
1988
be extended with the contents of that file (each line becomes a tag).
1989
In this case, there is not need to pass tags on the command line (if
1990
you do, tags from both sources will be removed). A file name of ``-``
1991
will be interpreted as stdin.
1992

    
1993
.. vim: set textwidth=72 :
1994
.. Local Variables:
1995
.. mode: rst
1996
.. fill-column: 72
1997
.. End: