Statistics
| Branch: | Tag: | Revision:

root / man / gnt-instance.rst @ bbafd35f

History | View | Annotate | Download (70.4 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}]
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

    
136
mode
137
    specifies the connection mode for this NIC: routed, bridged or
138
    openvswitch.
139

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

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

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

    
160

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

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

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

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

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

    
186
vcpus
187
    the number of VCPUs to assign to the instance (if this value makes
188
    sense for the hypervisor)
189

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

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

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

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

    
212
The possible hypervisor options are as follows:
213

    
214
boot\_order
215
    Valid for the Xen HVM and KVM hypervisors.
216

    
217
    A string value denoting the boot order. This has different meaning
218
    for the Xen HVM hypervisor and for the KVM one.
219

    
220
    For Xen HVM, The boot order is a string of letters listing the boot
221
    devices, with valid device letters being:
222

    
223
    a
224
        floppy drive
225

    
226
    c
227
        hard disk
228

    
229
    d
230
        CDROM drive
231

    
232
    n
233
        network boot (PXE)
234

    
235
    The default is not to set an HVM boot order, which is interpreted
236
    as 'dc'.
237

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

    
245
blockdev\_prefix
246
    Valid for the Xen HVM and PVM hypervisors.
247

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

    
252
floppy\_image\_path
253
    Valid for the KVM hypervisor.
254

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

    
260
cdrom\_image\_path
261
    Valid for the Xen HVM and KVM hypervisors.
262

    
263
    The path to a CDROM image to attach to the instance.
264

    
265
cdrom2\_image\_path
266
    Valid for the KVM hypervisor.
267

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

    
272
nic\_type
273
    Valid for the Xen HVM and KVM hypervisors.
274

    
275
    This parameter determines the way the network cards are presented
276
    to the instance. The possible options are:
277

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

    
288
vif\_type
289
    Valid for the Xen HVM hypervisor.
290

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

    
296
    - ioemu
297
    - vif
298

    
299
disk\_type
300
    Valid for the Xen HVM and KVM hypervisors.
301

    
302
    This parameter determines the way the disks are presented to the
303
    instance. The possible options are:
304

    
305
    - ioemu [default] (HVM & KVM)
306
    - ide (HVM & KVM)
307
    - scsi (KVM)
308
    - sd (KVM)
309
    - mtd (KVM)
310
    - pflash (KVM)
311

    
312

    
313
cdrom\_disk\_type
314
    Valid for the KVM hypervisor.
315

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

    
320
    - paravirtual
321
    - ide
322
    - scsi
323
    - sd
324
    - mtd
325
    - pflash
326

    
327

    
328
vnc\_bind\_address
329
    Valid for the Xen HVM and KVM hypervisors.
330

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

    
337
vnc\_tls
338
    Valid for the KVM hypervisor.
339

    
340
    A boolean option that controls whether the VNC connection is
341
    secured with TLS.
342

    
343
vnc\_x509\_path
344
    Valid for the KVM hypervisor.
345

    
346
    If ``vnc_tls`` is enabled, this options specifies the path to the
347
    x509 certificate to use.
348

    
349
vnc\_x509\_verify
350
    Valid for the KVM hypervisor.
351

    
352
spice\_bind
353
    Valid for the KVM hypervisor.
354

    
355
    Specifies the address or interface on which the SPICE server will
356
    listen. Valid values are:
357

    
358
    - IPv4 addresses, including 0.0.0.0 and 127.0.0.1
359
    - IPv6 addresses, including :: and ::1
360
    - names of network interfaces
361

    
362
    If a network interface is specified, the SPICE server will be bound
363
    to one of the addresses of that interface.
364

    
365
spice\_ip\_version
366
    Valid for the KVM hypervisor.
367

    
368
    Specifies which version of the IP protocol should be used by the
369
    SPICE server.
370

    
371
    It is mainly intended to be used for specifying what kind of IP
372
    addresses should be used if a network interface with both IPv4 and
373
    IPv6 addresses is specified via the ``spice_bind`` parameter. In
374
    this case, if the ``spice_ip_version`` parameter is not used, the
375
    default IP version of the cluster will be used.
376

    
377
spice\_password\_file
378
    Valid for the KVM hypervisor.
379

    
380
    Specifies a file containing the password that must be used when
381
    connecting via the SPICE protocol. If the option is not specified,
382
    passwordless connections are allowed.
383

    
384
spice\_image\_compression
385
    Valid for the KVM hypervisor.
386

    
387
    Configures the SPICE lossless image compression. Valid values are:
388

    
389
    - auto_glz
390
    - auto_lz
391
    - quic
392
    - glz
393
    - lz
394
    - off
395

    
396
spice\_jpeg\_wan\_compression
397
    Valid for the KVM hypervisor.
398

    
399
    Configures how SPICE should use the jpeg algorithm for lossy image
400
    compression on slow links. Valid values are:
401

    
402
    - auto
403
    - never
404
    - always
405

    
406
spice\_zlib\_glz\_wan\_compression
407
    Valid for the KVM hypervisor.
408

    
409
    Configures how SPICE should use the zlib-glz algorithm for lossy image
410
    compression on slow links. Valid values are:
411

    
412
    - auto
413
    - never
414
    - always
415

    
416
spice\_streaming\_video
417
    Valid for the KVM hypervisor.
418

    
419
    Configures how SPICE should detect video streams. Valid values are:
420

    
421
    - off
422
    - all
423
    - filter
424

    
425
spice\_playback\_compression
426
    Valid for the KVM hypervisor.
427

    
428
    Configures whether SPICE should compress audio streams or not.
429

    
430
spice\_use\_tls
431
    Valid for the KVM hypervisor.
432

    
433
    Specifies that the SPICE server must use TLS to encrypt all the
434
    traffic with the client.
435

    
436
spice\_tls\_ciphers
437
    Valid for the KVM hypervisor.
438

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

    
442
spice\_use\_vdagent
443
    Valid for the KVM hypervisor.
444

    
445
    Enables or disables passing mouse events via SPICE vdagent.
446

    
447
cpu\_type
448
    Valid for the KVM hypervisor.
449

    
450
    This parameter determines the emulated cpu for the instance. If this
451
    parameter is empty (which is the default configuration), it will not
452
    be passed to KVM.
453

    
454
    Be aware of setting this parameter to ``"host"`` if you have nodes
455
    with different CPUs from each other. Live migration may stop working
456
    in this situation.
457

    
458
    For more information please refer to the KVM manual.
459

    
460
acpi
461
    Valid for the Xen HVM and KVM hypervisors.
462

    
463
    A boolean option that specifies if the hypervisor should enable
464
    ACPI support for this instance. By default, ACPI is disabled.
465

    
466
pae
467
    Valid for the Xen HVM and KVM hypervisors.
468

    
469
    A boolean option that specifies if the hypervisor should enable
470
    PAE support for this instance. The default is false, disabling PAE
471
    support.
472

    
473
viridian
474
    Valid for the Xen HVM hypervisor.
475

    
476
    A boolean option that specifies if the hypervisor should enable
477
    viridian (Hyper-V) for this instance. The default is false,
478
    disabling viridian support.
479

    
480
use\_localtime
481
    Valid for the Xen HVM and KVM hypervisors.
482

    
483
    A boolean option that specifies if the instance should be started
484
    with its clock set to the localtime of the machine (when true) or
485
    to the UTC (When false). The default is false, which is useful for
486
    Linux/Unix machines; for Windows OSes, it is recommended to enable
487
    this parameter.
488

    
489
kernel\_path
490
    Valid for the Xen PVM and KVM hypervisors.
491

    
492
    This option specifies the path (on the node) to the kernel to boot
493
    the instance with. Xen PVM instances always require this, while for
494
    KVM if this option is empty, it will cause the machine to load the
495
    kernel from its disks (and the boot will be done accordingly to
496
    ``boot_order``).
497

    
498
kernel\_args
499
    Valid for the Xen PVM and KVM hypervisors.
500

    
501
    This options specifies extra arguments to the kernel that will be
502
    loaded. device. This is always used for Xen PVM, while for KVM it
503
    is only used if the ``kernel_path`` option is also specified.
504

    
505
    The default setting for this value is simply ``"ro"``, which
506
    mounts the root disk (initially) in read-only one. For example,
507
    setting this to single will cause the instance to start in
508
    single-user mode.
509

    
510
initrd\_path
511
    Valid for the Xen PVM and KVM hypervisors.
512

    
513
    This option specifies the path (on the node) to the initrd to boot
514
    the instance with. Xen PVM instances can use this always, while
515
    for KVM if this option is only used if the ``kernel_path`` option
516
    is also specified. You can pass here either an absolute filename
517
    (the path to the initrd) if you want to use an initrd, or use the
518
    format no\_initrd\_path for no initrd.
519

    
520
root\_path
521
    Valid for the Xen PVM and KVM hypervisors.
522

    
523
    This options specifies the name of the root device. This is always
524
    needed for Xen PVM, while for KVM it is only used if the
525
    ``kernel_path`` option is also specified.
526

    
527
    Please note, that if this setting is an empty string and the
528
    hypervisor is Xen it will not be written to the Xen configuration
529
    file
530

    
531
serial\_console
532
    Valid for the KVM hypervisor.
533

    
534
    This boolean option specifies whether to emulate a serial console
535
    for the instance. Note that some versions of KVM have a bug that
536
    will make an instance hang when configured to use the serial console
537
    unless a connection is made to it within about 2 seconds of the
538
    instance's startup. For such case it's recommended to disable this
539
    option, which is enabled by default.
540

    
541
serial\_speed
542
    Valid for the KVM hypervisor.
543

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

    
549
disk\_cache
550
    Valid for the KVM hypervisor.
551

    
552
    The disk cache mode. It can be either default to not pass any
553
    cache option to KVM, or one of the KVM cache modes: none (for
554
    direct I/O), writethrough (to use the host cache but report
555
    completion to the guest only when the host has committed the
556
    changes to disk) or writeback (to use the host cache and report
557
    completion as soon as the data is in the host cache). Note that
558
    there are special considerations for the cache mode depending on
559
    version of KVM used and disk type (always raw file under Ganeti),
560
    please refer to the KVM documentation for more details.
561

    
562
security\_model
563
    Valid for the KVM hypervisor.
564

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

    
569
    Under *user* kvm will drop privileges and become the user
570
    specified by the security\_domain parameter.
571

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

    
576
security\_domain
577
    Valid for the KVM hypervisor.
578

    
579
    Under security model *user* the username to run the instance
580
    under.  It must be a valid username existing on the host.
581

    
582
    Cannot be set under security model *none* or *pool*.
583

    
584
kvm\_flag
585
    Valid for the KVM hypervisor.
586

    
587
    If *enabled* the -enable-kvm flag is passed to kvm. If *disabled*
588
    -disable-kvm is passed. If unset no flag is passed, and the
589
    default running mode for your kvm binary will be used.
590

    
591
mem\_path
592
    Valid for the KVM hypervisor.
593

    
594
    This option passes the -mem-path argument to kvm with the path (on
595
    the node) to the mount point of the hugetlbfs file system, along
596
    with the -mem-prealloc argument too.
597

    
598
use\_chroot
599
    Valid for the KVM hypervisor.
600

    
601
    This boolean option determines whether to run the KVM instance in a
602
    chroot directory.
603

    
604
    If it is set to ``true``, an empty directory is created before
605
    starting the instance and its path is passed via the -chroot flag
606
    to kvm. The directory is removed when the instance is stopped.
607

    
608
    It is set to ``false`` by default.
609

    
610
migration\_downtime
611
    Valid for the KVM hypervisor.
612

    
613
    The maximum amount of time (in ms) a KVM instance is allowed to be
614
    frozen during a live migration, in order to copy dirty memory
615
    pages. Default value is 30ms, but you may need to increase this
616
    value for busy instances.
617

    
618
    This option is only effective with kvm versions >= 87 and qemu-kvm
619
    versions >= 0.11.0.
620

    
621
cpu\_mask
622
    Valid for the Xen, KVM and LXC hypervisors.
623

    
624
    The processes belonging to the given instance are only scheduled
625
    on the specified CPUs.
626

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

    
631
    Second, a comma-separated list of CPU IDs or CPU ID ranges. The
632
    ranges are defined by a lower and higher boundary, separated by a
633
    dash, and the boundaries are inclusive. In this form, all VCPUs of
634
    the instance will be mapped on the selected list of CPUs. Example:
635
    ``0-2,5``, mapping all VCPUs (no matter how many) onto physical CPUs
636
    0, 1, 2 and 5.
637

    
638
    The last form is used for explicit control of VCPU-CPU pinnings. In
639
    this form, the list of VCPU mappings is given as a colon (:)
640
    separated list, whose elements are the possible values for the
641
    second or first form above. In this form, the number of elements in
642
    the colon-separated list _must_ equal the number of VCPUs of the
643
    instance.
644

    
645
    Example:
646

    
647
    .. code-block:: bash
648

    
649
      # Map the entire instance to CPUs 0-2
650
      gnt-instance modify -H cpu_mask=0-2 my-inst
651

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

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

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

    
662
      # Pin entire VM to CPU 0
663
      gnt-instance modify -H cpu_mask=0 my-inst
664

    
665
      # Turn off CPU pinning (default setting)
666
      gnt-instance modify -H cpu_mask=all my-inst
667

    
668
cpu\_cap
669
    Valid for the Xen hypervisor.
670

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

    
674
cpu\_weight
675
    Valid for the Xen hypervisor.
676

    
677
    Set the cpu time ratio to be allocated to the VM. Valid values are
678
    between 1 and 65535. Default weight is 256.
679

    
680
usb\_mouse
681
    Valid for the KVM hypervisor.
682

    
683
    This option specifies the usb mouse type to be used. It can be
684
    "mouse" or "tablet". When using VNC it's recommended to set it to
685
    "tablet".
686

    
687
keymap
688
    Valid for the KVM hypervisor.
689

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

    
693
reboot\_behavior
694
    Valid for Xen PVM, Xen HVM and KVM hypervisors.
695

    
696
    Normally if an instance reboots, the hypervisor will restart it. If
697
    this option is set to ``exit``, the hypervisor will treat a reboot
698
    as a shutdown instead.
699

    
700
    It is set to ``reboot`` by default.
701

    
702
cpu\_cores
703
    Valid for the KVM hypervisor.
704

    
705
    Number of emulated CPU cores.
706

    
707
cpu\_threads
708
    Valid for the KVM hypervisor.
709

    
710
    Number of emulated CPU threads.
711

    
712
cpu\_sockets
713
    Valid for the KVM hypervisor.
714

    
715
    Number of emulated CPU sockets.
716

    
717
soundhw
718
    Valid for the KVM hypervisor.
719

    
720
    Comma separated list of emulated sounds cards, or "all" to enable
721
    all the available ones.
722

    
723
usb\_devices
724
    Valid for the KVM hypervisor.
725

    
726
    Comma separated list of usb devices. These can be emulated devices
727
    or passthrough ones, and each one gets passed to kvm with its own
728
    ``-usbdevice`` option. See the **qemu**\(1) manpage for the syntax
729
    of the possible components.
730

    
731
vga
732
    Valid for the KVM hypervisor.
733

    
734
    Emulated vga mode, passed the the kvm -vga option.
735

    
736
kvm\_extra
737
    Valid for the KVM hypervisor.
738

    
739
    Any other option to the KVM hypervisor, useful tweaking anything
740
    that Ganeti doesn't support. Note that values set with this
741
    parameter are split on a space character and currently don't support
742
    quoting.
743

    
744
machine\_version
745
    Valid for the KVM hypervisor.
746

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

    
751
kvm\_path
752
    Valid for the KVM hypervisor.
753

    
754
    Path to the userspace KVM (or qemu) program.
755

    
756
vnet\_hdr
757
    Valid for the KVM hypervisor.
758

    
759
    This boolean option determines whether the tap devices used by the
760
    KVM paravirtual nics (virtio-net) will get created with VNET_HDR
761
    (IFF_VNET_HDR) support.
762

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

    
767
    It is set to ``true`` by default.
768

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

    
774
    gnt-instance add -O dhcp=yes ...
775

    
776
The ``-I (--iallocator)`` option specifies the instance allocator plugin
777
to use (``.`` means the default allocator). If you pass in this option
778
the allocator will select nodes for this instance automatically, so you
779
don't need to pass them with the ``-n`` option. For more information
780
please refer to the instance allocator documentation.
781

    
782
The ``-t (--disk-template)`` options specifies the disk layout type
783
for the instance.  The available choices are:
784

    
785
diskless
786
    This creates an instance with no disks. Its useful for testing only
787
    (or other special cases).
788

    
789
file
790
    Disk devices will be regular files.
791

    
792
sharedfile
793
    Disk devices will be regulare files on a shared directory.
794

    
795
plain
796
    Disk devices will be logical volumes.
797

    
798
drbd
799
    Disk devices will be drbd (version 8.x) on top of lvm volumes.
800

    
801
rbd
802
    Disk devices will be rbd volumes residing inside a RADOS cluster.
803

    
804
blockdev
805
    Disk devices will be adopted pre-existent block devices.
806

    
807
ext
808
    Disk devices will be provided by external shared storage,
809
    through the ExtStorage Interface using ExtStorage providers.
810

    
811
The optional second value of the ``-n (--node)`` is used for the drbd
812
template type and specifies the remote node.
813

    
814
If you do not want gnt-instance to wait for the disk mirror to be
815
synced, use the ``--no-wait-for-sync`` option.
816

    
817
The ``--file-storage-dir`` specifies the relative path under the
818
cluster-wide file storage directory to store file-based disks. It is
819
useful for having different subdirectories for different
820
instances. The full path of the directory where the disk files are
821
stored will consist of cluster-wide file storage directory + optional
822
subdirectory + instance name. Example:
823
``@RPL_FILE_STORAGE_DIR@/mysubdir/instance1.example.com``. This
824
option is only relevant for instances using the file storage backend.
825

    
826
The ``--file-driver`` specifies the driver to use for file-based
827
disks. Note that currently these drivers work with the xen hypervisor
828
only. This option is only relevant for instances using the file
829
storage backend. The available choices are:
830

    
831
loop
832
    Kernel loopback driver. This driver uses loopback devices to
833
    access the filesystem within the file. However, running I/O
834
    intensive applications in your instance using the loop driver
835
    might result in slowdowns. Furthermore, if you use the loopback
836
    driver consider increasing the maximum amount of loopback devices
837
    (on most systems it's 8) using the max\_loop param.
838

    
839
blktap
840
    The blktap driver (for Xen hypervisors). In order to be able to
841
    use the blktap driver you should check if the 'blktapctrl' user
842
    space disk agent is running (usually automatically started via
843
    xend).  This user-level disk I/O interface has the advantage of
844
    better performance. Especially if you use a network file system
845
    (e.g. NFS) to store your instances this is the recommended choice.
846

    
847
If ``--ignore-ipolicy`` is given any instance policy violations occuring
848
during this operation are ignored.
849

    
850
See **ganeti**\(7) for a description of ``--submit`` and other common
851
options.
852

    
853
Example::
854

    
855
    # gnt-instance add -t file --disk 0:size=30g -B maxmem=512 -o debian-etch \
856
      -n node1.example.com --file-storage-dir=mysubdir instance1.example.com
857
    # gnt-instance add -t plain --disk 0:size=30g -B maxmem=1024,minmem=512 \
858
      -o debian-etch -n node1.example.com instance1.example.com
859
    # gnt-instance add -t plain --disk 0:size=30g --disk 1:size=100g,vg=san \
860
      -B maxmem=512 -o debian-etch -n node1.example.com instance1.example.com
861
    # gnt-instance add -t drbd --disk 0:size=30g -B maxmem=512 -o debian-etch \
862
      -n node1.example.com:node2.example.com instance2.example.com
863
    # gnt-instance add -t rbd --disk 0:size=30g -B maxmem=512 -o debian-etch \
864
      -n node1.example.com instance1.example.com
865
    # gnt-instance add -t ext --disk 0:size=30g,provider=pvdr1 -B maxmem=512 \
866
      -o debian-etch -n node1.example.com instance1.example.com
867
    # gnt-instance add -t ext --disk 0:size=30g,provider=pvdr1,param1=val1 \
868
      --disk 1:size=40g,provider=pvdr2,param2=val2,param3=val3 -B maxmem=512 \
869
      -o debian-etch -n node1.example.com instance1.example.com
870

    
871

    
872
BATCH-CREATE
873
^^^^^^^^^^^^
874

    
875
| **batch-create**
876
| [{-I|\--iallocator} *instance allocator*]
877
| {instances\_file.json}
878

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

    
886
The instance file must be a valid-formed JSON file, containing an
887
array of dictionaries with instance creation parameters. All parameters
888
(except ``iallocator``) which are valid for the instance creation
889
OP code are allowed. The most important ones are:
890

    
891
instance\_name
892
    The FQDN of the new instance.
893

    
894
disk\_template
895
    The disk template to use for the instance, the same as in the
896
    **add** command.
897

    
898
disks
899
    Array of disk specifications. Each entry describes one disk as a
900
    dictionary of disk parameters.
901

    
902
beparams
903
    A dictionary of backend parameters.
904

    
905
hypervisor
906
    The hypervisor for the instance.
907

    
908
hvparams
909
    A dictionary with the hypervisor options. If not passed, the default
910
    hypervisor options will be inherited.
911

    
912
nics
913
    List of NICs that will be created for the instance. Each entry
914
    should be a dict, with mac, ip, mode and link as possible keys.
915
    Please don't provide the "mac, ip, mode, link" parent keys if you
916
    use this method for specifying NICs.
917

    
918
pnode, snode
919
    The primary and optionally the secondary node to use for the
920
    instance (in case an iallocator script is not used). If those
921
    parameters are given, they have to be given consistently for all
922
    instances in the batch operation.
923

    
924
start
925
    whether to start the instance
926

    
927
ip\_check
928
    Skip the check for already-in-use instance; see the description in
929
    the **add** command for details.
930

    
931
name\_check
932
    Skip the name check for instances; see the description in the
933
    **add** command for details.
934

    
935
file\_storage\_dir, file\_driver
936
    Configuration for the file disk type, see the **add** command for
937
    details.
938

    
939

    
940
A simple definition for one instance can be (with most of the
941
parameters taken from the cluster defaults)::
942

    
943
    [
944
      {
945
        "mode": "create",
946
        "instance_name": "instance1.example.com",
947
        "disk_template": "drbd",
948
        "os_type": "debootstrap",
949
        "disks": [{"size":"1024"}],
950
        "nics": [{}],
951
        "hypervisor": "xen-pvm"
952
      },
953
      {
954
        "mode": "create",
955
        "instance_name": "instance2.example.com",
956
        "disk_template": "drbd",
957
        "os_type": "debootstrap",
958
        "disks": [{"size":"4096", "mode": "rw", "vg": "xenvg"}],
959
        "nics": [{}],
960
        "hypervisor": "xen-hvm",
961
        "hvparams": {"acpi": true},
962
        "beparams": {"maxmem": 512, "minmem": 256}
963
      }
964
    ]
965

    
966
The command will display the job id for each submitted instance, as
967
follows::
968

    
969
    # gnt-instance batch-create instances.json
970
    Submitted jobs 37, 38
971

    
972
REMOVE
973
^^^^^^
974

    
975
**remove** [\--ignore-failures] [\--shutdown-timeout=*N*] [\--submit]
976
[\--force] {*instance*}
977

    
978
Remove an instance. This will remove all data from the instance and
979
there is *no way back*. If you are not sure if you use an instance
980
again, use **shutdown** first and leave it in the shutdown state for a
981
while.
982

    
983
The ``--ignore-failures`` option will cause the removal to proceed
984
even in the presence of errors during the removal of the instance
985
(e.g. during the shutdown or the disk removal). If this option is not
986
given, the command will stop at the first error.
987

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

    
993
The ``--force`` option is used to skip the interactive confirmation.
994

    
995
See **ganeti**\(7) for a description of ``--submit`` and other common
996
options.
997

    
998
Example::
999

    
1000
    # gnt-instance remove instance1.example.com
1001

    
1002

    
1003
LIST
1004
^^^^
1005

    
1006
| **list**
1007
| [\--no-headers] [\--separator=*SEPARATOR*] [\--units=*UNITS*] [-v]
1008
| [{-o|\--output} *[+]FIELD,...*] [\--filter] [instance...]
1009

    
1010
Shows the currently configured instances with memory usage, disk
1011
usage, the node they are running on, and their run status.
1012

    
1013
The ``--no-headers`` option will skip the initial header line. The
1014
``--separator`` option takes an argument which denotes what will be
1015
used between the output fields. Both these options are to help
1016
scripting.
1017

    
1018
The units used to display the numeric values in the output varies,
1019
depending on the options given. By default, the values will be
1020
formatted in the most appropriate unit. If the ``--separator`` option
1021
is given, then the values are shown in mebibytes to allow parsing by
1022
scripts. In both cases, the ``--units`` option can be used to enforce
1023
a given output unit.
1024

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

    
1028
The ``-o (--output)`` option takes a comma-separated list of output
1029
fields. The available fields and their meaning are:
1030

    
1031
@QUERY_FIELDS_INSTANCE@
1032

    
1033
If the value of the option starts with the character ``+``, the new
1034
field(s) will be added to the default list. This allows one to quickly
1035
see the default list plus a few other fields, instead of retyping the
1036
entire list of fields.
1037

    
1038
There is a subtle grouping about the available output fields: all
1039
fields except for ``oper_state``, ``oper_ram``, ``oper_vcpus`` and
1040
``status`` are configuration value and not run-time values. So if you
1041
don't select any of the these fields, the query will be satisfied
1042
instantly from the cluster configuration, without having to ask the
1043
remote nodes for the data. This can be helpful for big clusters when
1044
you only want some data and it makes sense to specify a reduced set of
1045
output fields.
1046

    
1047
If exactly one argument is given and it appears to be a query filter
1048
(see **ganeti**\(7)), the query result is filtered accordingly. For
1049
ambiguous cases (e.g. a single field name as a filter) the ``--filter``
1050
(``-F``) option forces the argument to be treated as a filter (e.g.
1051
``gnt-instance list -F admin_state``).
1052

    
1053
The default output field list is: ``name``, ``os``, ``pnode``,
1054
``admin_state``, ``oper_state``, ``oper_ram``.
1055

    
1056

    
1057
LIST-FIELDS
1058
^^^^^^^^^^^
1059

    
1060
**list-fields** [field...]
1061

    
1062
Lists available fields for instances.
1063

    
1064

    
1065
INFO
1066
^^^^
1067

    
1068
**info** [-s \| \--static] [\--roman] {\--all \| *instance*}
1069

    
1070
Show detailed information about the given instance(s). This is
1071
different from **list** as it shows detailed data about the instance's
1072
disks (especially useful for the drbd disk template).
1073

    
1074
If the option ``-s`` is used, only information available in the
1075
configuration file is returned, without querying nodes, making the
1076
operation faster.
1077

    
1078
Use the ``--all`` to get info about all instances, rather than
1079
explicitly passing the ones you're interested in.
1080

    
1081
The ``--roman`` option can be used to cause envy among people who like
1082
ancient cultures, but are stuck with non-latin-friendly cluster
1083
virtualization technologies.
1084

    
1085
MODIFY
1086
^^^^^^
1087

    
1088
| **modify**
1089
| [{-H|\--hypervisor-parameters} *HYPERVISOR\_PARAMETERS*]
1090
| [{-B|\--backend-parameters} *BACKEND\_PARAMETERS*]
1091
| [{-m|\--runtime-memory} *SIZE*]
1092
| [\--net add[:options...] \|
1093
|  \--net [*N*:]add[,options...] \|
1094
|  \--net [*ID*:]remove \|
1095
|  \--net *ID*:modify[,options...]]
1096
| [\--disk add:size=*SIZE*[,options...] \|
1097
|  \--disk *N*:add,size=*SIZE*[,options...] \|
1098
|  \--disk *N*:add,size=*SIZE*,provider=*PROVIDER*[,options...][,param=*value*... ] \|
1099
|  \--disk *ID*:modify[,options...]
1100
|  \--disk [*ID*:]remove]
1101
| [{-t|\--disk-template} plain | {-t|\--disk-template} drbd -n *new_secondary*] [\--no-wait-for-sync]
1102
| [\--new-primary=*node*]
1103
| [\--os-type=*OS* [\--force-variant]]
1104
| [{-O|\--os-parameters} *param*=*value*... ]
1105
| [\--offline \| \--online]
1106
| [\--submit]
1107
| [\--ignore-ipolicy]
1108
| [\--hotplug]
1109
| {*instance*}
1110

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

    
1116
The ``-H (--hypervisor-parameters)``, ``-B (--backend-parameters)``
1117
and ``-O (--os-parameters)`` options specifies hypervisor, backend and
1118
OS parameter options in the form of name=value[,...]. For details
1119
which options can be specified, see the **add** command.
1120

    
1121
The ``-t (--disk-template)`` option will change the disk template of
1122
the instance.  Currently only conversions between the plain and drbd
1123
disk templates are supported, and the instance must be stopped before
1124
attempting the conversion. When changing from the plain to the drbd
1125
disk template, a new secondary node must be specified via the ``-n``
1126
option. The option ``--no-wait-for-sync`` can be used when converting
1127
to the ``drbd`` template in order to make the instance available for
1128
startup before DRBD has finished resyncing.
1129

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

    
1134
The ``--disk add:size=*SIZE*,[options..]`` option adds a disk to the
1135
instance, and ``--disk *N*:add:size=*SIZE*,[options..]`` will add a disk
1136
to the the instance at a specific index. The available options are the
1137
same as in the **add** command(``mode``, ``name``, ``vg``, ``metavg``).
1138
When adding an ExtStorage disk the ``provider=*PROVIDER*`` option is
1139
also mandatory and specifies the ExtStorage provider. Also, for
1140
ExtStorage disks arbitrary parameters can be passed as additional comma
1141
separated options, same as in the **add** command. -The ``--disk remove``
1142
option will remove the last disk of the instance. Use
1143
``--disk `` *ID*``:remove`` to remove a disk by its identifier.  *ID*
1144
can be the index of the disk, the disks's name or the disks's UUID.  The
1145
``--disk *ID*:modify[,options...]`` wil change the options of the disk.
1146
Available options are:
1147

    
1148
mode
1149
  The access mode. Either ``ro`` (read-only) or the default ``rw`` (read-write).
1150

    
1151
name
1152
   this option specifies a name for the disk, which can be used as a disk
1153
   identifier. An instance can not have two disks with the same name.
1154

    
1155
The ``--net *N*:add[,options..]`` will add a new network interface to
1156
the instance. The available options are the same as in the **add**
1157
command (``mac``, ``ip``, ``link``, ``mode``, ``network``). The
1158
``--net *ID*,remove`` will remove the intances' NIC with *ID* identifier,
1159
which can be the index of the NIC, the NIC's name or the NIC's UUID.
1160
The ``--net *ID*:modify[,options..]`` option will change the parameters of
1161
the instance network interface with the *ID* identifier.
1162

    
1163
The option ``-o (--os-type)`` will change the OS name for the instance
1164
(without reinstallation). In case an OS variant is specified that is
1165
not found, then by default the modification is refused, unless
1166
``--force-variant`` is passed. An invalid OS will also be refused,
1167
unless the ``--force`` option is given.
1168

    
1169
The option ``--new-primary`` will set the new primary node of an instance
1170
assuming the disks have already been moved manually. Unless the ``--force``
1171
option is given, it is verified that the instance is no longer running
1172
on its current primary node.
1173

    
1174
The ``--online`` and ``--offline`` options are used to transition an
1175
instance into and out of the ``offline`` state. An instance can be
1176
turned offline only if it was previously down. The ``--online`` option
1177
fails if the instance was not in the ``offline`` state, otherwise it
1178
changes instance's state to ``down``. These modifications take effect
1179
immediately.
1180

    
1181
If ``--ignore-ipolicy`` is given any instance policy violations occuring
1182
during this operation are ignored.
1183

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

    
1194
See **ganeti**\(7) for a description of ``--submit`` and other common
1195
options.
1196

    
1197
Most of the changes take effect at the next restart. If the instance is
1198
running, there is no effect on the instance.
1199

    
1200
REINSTALL
1201
^^^^^^^^^
1202

    
1203
| **reinstall** [{-o|\--os-type} *os-type*] [\--select-os] [-f *force*]
1204
| [\--force-multiple]
1205
| [\--instance \| \--node \| \--primary \| \--secondary \| \--all]
1206
| [{-O|\--os-parameters} *OS\_PARAMETERS*] [\--submit] {*instance*...}
1207

    
1208
Reinstalls the operating system on the given instance(s). The
1209
instance(s) must be stopped when running this command. If the ``-o
1210
(--os-type)`` is specified, the operating system is changed.
1211

    
1212
The ``--select-os`` option switches to an interactive OS reinstall.
1213
The user is prompted to select the OS template from the list of
1214
available OS templates. OS parameters can be overridden using ``-O
1215
(--os-parameters)`` (more documentation for this option under the
1216
**add** command).
1217

    
1218
Since this is a potentially dangerous command, the user will be
1219
required to confirm this action, unless the ``-f`` flag is passed.
1220
When multiple instances are selected (either by passing multiple
1221
arguments or by using the ``--node``, ``--primary``, ``--secondary``
1222
or ``--all`` options), the user must pass the ``--force-multiple``
1223
options to skip the interactive confirmation.
1224

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

    
1228
RENAME
1229
^^^^^^
1230

    
1231
| **rename** [\--no-ip-check] [\--no-name-check] [\--submit]
1232
| {*instance*} {*new\_name*}
1233

    
1234
Renames the given instance. The instance must be stopped when running
1235
this command. The requirements for the new name are the same as for
1236
adding an instance: the new name must be resolvable and the IP it
1237
resolves to must not be reachable (in order to prevent duplicate IPs
1238
the next time the instance is started). The IP test can be skipped if
1239
the ``--no-ip-check`` option is passed.
1240

    
1241
Note that you can rename an instance to its same name, to force
1242
re-executing the os-specific rename script for that instance, if
1243
needed.
1244

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

    
1251
See **ganeti**\(7) for a description of ``--submit`` and other common
1252
options.
1253

    
1254
Starting/stopping/connecting to console
1255
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1256

    
1257
STARTUP
1258
^^^^^^^
1259

    
1260
| **startup**
1261
| [\--force] [\--ignore-offline]
1262
| [\--force-multiple] [\--no-remember]
1263
| [\--instance \| \--node \| \--primary \| \--secondary \| \--all \|
1264
| \--tags \| \--node-tags \| \--pri-node-tags \| \--sec-node-tags]
1265
| [{-H|\--hypervisor-parameters} ``key=value...``]
1266
| [{-B|\--backend-parameters} ``key=value...``]
1267
| [\--submit] [\--paused]
1268
| {*name*...}
1269

    
1270
Starts one or more instances, depending on the following options.  The
1271
four available modes are:
1272

    
1273
\--instance
1274
    will start the instances given as arguments (at least one argument
1275
    required); this is the default selection
1276

    
1277
\--node
1278
    will start the instances who have the given node as either primary
1279
    or secondary
1280

    
1281
\--primary
1282
    will start all instances whose primary node is in the list of nodes
1283
    passed as arguments (at least one node required)
1284

    
1285
\--secondary
1286
    will start all instances whose secondary node is in the list of
1287
    nodes passed as arguments (at least one node required)
1288

    
1289
\--all
1290
    will start all instances in the cluster (no arguments accepted)
1291

    
1292
\--tags
1293
    will start all instances in the cluster with the tags given as
1294
    arguments
1295

    
1296
\--node-tags
1297
    will start all instances in the cluster on nodes with the tags
1298
    given as arguments
1299

    
1300
\--pri-node-tags
1301
    will start all instances in the cluster on primary nodes with the
1302
    tags given as arguments
1303

    
1304
\--sec-node-tags
1305
    will start all instances in the cluster on secondary nodes with the
1306
    tags given as arguments
1307

    
1308
Note that although you can pass more than one selection option, the
1309
last one wins, so in order to guarantee the desired result, don't pass
1310
more than one such option.
1311

    
1312
Use ``--force`` to start even if secondary disks are failing.
1313
``--ignore-offline`` can be used to ignore offline primary nodes and
1314
mark the instance as started even if the primary is not available.
1315

    
1316
The ``--force-multiple`` will skip the interactive confirmation in the
1317
case the more than one instance will be affected.
1318

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

    
1325
The ``-H (--hypervisor-parameters)`` and ``-B (--backend-parameters)``
1326
options specify temporary hypervisor and backend parameters that can
1327
be used to start an instance with modified parameters. They can be
1328
useful for quick testing without having to modify an instance back and
1329
forth, e.g.::
1330

    
1331
    # gnt-instance start -H kernel_args="single" instance1
1332
    # gnt-instance start -B maxmem=2048 instance2
1333

    
1334

    
1335
The first form will start the instance instance1 in single-user mode,
1336
and the instance instance2 with 2GB of RAM (this time only, unless
1337
that is the actual instance memory size already). Note that the values
1338
override the instance parameters (and not extend them): an instance
1339
with "kernel\_args=ro" when started with -H kernel\_args=single will
1340
result in "single", not "ro single".
1341

    
1342
The ``--paused`` option is only valid for Xen and kvm hypervisors.  This
1343
pauses the instance at the start of bootup, awaiting ``gnt-instance
1344
console`` to unpause it, allowing the entire boot process to be
1345
monitored for debugging.
1346

    
1347
See **ganeti**\(7) for a description of ``--submit`` and other common
1348
options.
1349

    
1350
Example::
1351

    
1352
    # gnt-instance start instance1.example.com
1353
    # gnt-instance start --node node1.example.com node2.example.com
1354
    # gnt-instance start --all
1355

    
1356

    
1357
SHUTDOWN
1358
^^^^^^^^
1359

    
1360
| **shutdown**
1361
| [\--timeout=*N*]
1362
| [\--force] [\--force-multiple] [\--ignore-offline] [\--no-remember]
1363
| [\--instance \| \--node \| \--primary \| \--secondary \| \--all \|
1364
| \--tags \| \--node-tags \| \--pri-node-tags \| \--sec-node-tags]
1365
| [\--submit]
1366
| {*name*...}
1367

    
1368
Stops one or more instances. If the instance cannot be cleanly stopped
1369
during a hardcoded interval (currently 2 minutes), it will forcibly
1370
stop the instance (equivalent to switching off the power on a physical
1371
machine).
1372

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

    
1378
The ``--instance``, ``--node``, ``--primary``, ``--secondary``,
1379
``--all``, ``--tags``, ``--node-tags``, ``--pri-node-tags`` and
1380
``--sec-node-tags`` options are similar as for the **startup** command
1381
and they influence the actual instances being shutdown.
1382

    
1383
``--ignore-offline`` can be used to ignore offline primary nodes and
1384
force the instance to be marked as stopped. This option should be used
1385
with care as it can lead to an inconsistent cluster state.
1386

    
1387
Use ``--force`` to be able to shutdown an instance even when it's marked
1388
as offline. This is useful is an offline instance ends up in the
1389
``ERROR_up`` state, for example.
1390

    
1391
The ``--no-remember`` option will perform the shutdown but not change
1392
the state of the instance in the configuration file (if it was running
1393
before, Ganeti will still thinks it needs to be running). This can be
1394
useful for a cluster-wide shutdown, where some instances are marked as
1395
up and some as down, and you don't want to change the running state:
1396
you just need to disable the watcher, shutdown all instances with
1397
``--no-remember``, and when the watcher is activated again it will
1398
restore the correct runtime state for all instances.
1399

    
1400
See **ganeti**\(7) for a description of ``--submit`` and other common
1401
options.
1402

    
1403
Example::
1404

    
1405
    # gnt-instance shutdown instance1.example.com
1406
    # gnt-instance shutdown --all
1407

    
1408

    
1409
REBOOT
1410
^^^^^^
1411

    
1412
| **reboot**
1413
| [{-t|\--type} *REBOOT-TYPE*]
1414
| [\--ignore-secondaries]
1415
| [\--shutdown-timeout=*N*]
1416
| [\--force-multiple]
1417
| [\--instance \| \--node \| \--primary \| \--secondary \| \--all \|
1418
| \--tags \| \--node-tags \| \--pri-node-tags \| \--sec-node-tags]
1419
| [\--submit]
1420
| [*name*...]
1421

    
1422
Reboots one or more instances. The type of reboot depends on the value
1423
of ``-t (--type)``. A soft reboot does a hypervisor reboot, a hard reboot
1424
does a instance stop, recreates the hypervisor config for the instance
1425
and starts the instance. A full reboot does the equivalent of
1426
**gnt-instance shutdown && gnt-instance startup**.  The default is
1427
hard reboot.
1428

    
1429
For the hard reboot the option ``--ignore-secondaries`` ignores errors
1430
for the secondary node while re-assembling the instance disks.
1431

    
1432
The ``--instance``, ``--node``, ``--primary``, ``--secondary``,
1433
``--all``, ``--tags``, ``--node-tags``, ``--pri-node-tags`` and
1434
``--sec-node-tags`` options are similar as for the **startup** command
1435
and they influence the actual instances being rebooted.
1436

    
1437
The ``--shutdown-timeout`` is used to specify how much time to wait
1438
before forcing the shutdown (xm destroy in xen, killing the kvm
1439
process, for kvm). By default two minutes are given to each instance
1440
to stop.
1441

    
1442
The ``--force-multiple`` will skip the interactive confirmation in the
1443
case the more than one instance will be affected.
1444

    
1445
See **ganeti**\(7) for a description of ``--submit`` and other common
1446
options.
1447

    
1448
Example::
1449

    
1450
    # gnt-instance reboot instance1.example.com
1451
    # gnt-instance reboot --type=full instance1.example.com
1452

    
1453

    
1454
CONSOLE
1455
^^^^^^^
1456

    
1457
**console** [\--show-cmd] {*instance*}
1458

    
1459
Connects to the console of the given instance. If the instance is not
1460
up, an error is returned. Use the ``--show-cmd`` option to display the
1461
command instead of executing it.
1462

    
1463
For HVM instances, this will attempt to connect to the serial console
1464
of the instance. To connect to the virtualized "physical" console of a
1465
HVM instance, use a VNC client with the connection info from the
1466
**info** command.
1467

    
1468
For Xen/kvm instances, if the instance is paused, this attempts to
1469
unpause the instance after waiting a few seconds for the connection to
1470
the console to be made.
1471

    
1472
Example::
1473

    
1474
    # gnt-instance console instance1.example.com
1475

    
1476

    
1477
Disk management
1478
~~~~~~~~~~~~~~~
1479

    
1480
REPLACE-DISKS
1481
^^^^^^^^^^^^^
1482

    
1483
**replace-disks** [\--submit] [\--early-release] [\--ignore-ipolicy] {-p}
1484
[\--disks *idx*] {*instance*}
1485

    
1486
**replace-disks** [\--submit] [\--early-release] [\--ignore-ipolicy] {-s}
1487
[\--disks *idx*] {*instance*}
1488

    
1489
**replace-disks** [\--submit] [\--early-release] [\--ignore-ipolicy]
1490
{{-I\|\--iallocator} *name* \| {{-n|\--new-secondary} *node* } {*instance*}
1491

    
1492
**replace-disks** [\--submit] [\--early-release] [\--ignore-ipolicy]
1493
{-a\|\--auto} {*instance*}
1494

    
1495
This command is a generalized form for replacing disks. It is
1496
currently only valid for the mirrored (DRBD) disk template.
1497

    
1498
The first form (when passing the ``-p`` option) will replace the disks
1499
on the primary, while the second form (when passing the ``-s`` option
1500
will replace the disks on the secondary node. For these two cases (as
1501
the node doesn't change), it is possible to only run the replace for a
1502
subset of the disks, using the option ``--disks`` which takes a list
1503
of comma-delimited disk indices (zero-based), e.g. 0,2 to replace only
1504
the first and third disks.
1505

    
1506
The third form (when passing either the ``--iallocator`` or the
1507
``--new-secondary`` option) is designed to change secondary node of the
1508
instance. Specifying ``--iallocator`` makes the new secondary be
1509
selected automatically by the specified allocator plugin (use ``.`` to
1510
indicate the default allocator), otherwise the new secondary node will
1511
be the one chosen manually via the ``--new-secondary`` option.
1512

    
1513
Note that it is not possible to select an offline or drained node as a
1514
new secondary.
1515

    
1516
The fourth form (when using ``--auto``) will automatically determine
1517
which disks of an instance are faulty and replace them within the same
1518
node. The ``--auto`` option works only when an instance has only
1519
faulty disks on either the primary or secondary node; it doesn't work
1520
when both sides have faulty disks.
1521

    
1522
The ``--early-release`` changes the code so that the old storage on
1523
secondary node(s) is removed early (before the resync is completed)
1524
and the internal Ganeti locks for the current (and new, if any)
1525
secondary node are also released, thus allowing more parallelism in
1526
the cluster operation. This should be used only when recovering from a
1527
disk failure on the current secondary (thus the old storage is already
1528
broken) or when the storage on the primary node is known to be fine
1529
(thus we won't need the old storage for potential recovery).
1530

    
1531
The ``--ignore-ipolicy`` let the command ignore instance policy
1532
violations if replace-disks changes groups and the instance would
1533
violate the new groups instance policy.
1534

    
1535
See **ganeti**\(7) for a description of ``--submit`` and other common
1536
options.
1537

    
1538
ACTIVATE-DISKS
1539
^^^^^^^^^^^^^^
1540

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

    
1543
Activates the block devices of the given instance. If successful, the
1544
command will show the location and name of the block devices::
1545

    
1546
    node1.example.com:disk/0:/dev/drbd0
1547
    node1.example.com:disk/1:/dev/drbd1
1548

    
1549

    
1550
In this example, *node1.example.com* is the name of the node on which
1551
the devices have been activated. The *disk/0* and *disk/1* are the
1552
Ganeti-names of the instance disks; how they are visible inside the
1553
instance is hypervisor-specific. */dev/drbd0* and */dev/drbd1* are the
1554
actual block devices as visible on the node.
1555

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

    
1563
The ``--wait-for-sync`` option will ensure that the command returns only
1564
after the instance's disks are synchronised (mostly for DRBD); this can
1565
be useful to ensure consistency, as otherwise there are no commands that
1566
can wait until synchronisation is done. However when passing this
1567
option, the command will have additional output, making it harder to
1568
parse the disk information.
1569

    
1570
Note that it is safe to run this command while the instance is already
1571
running.
1572

    
1573
See **ganeti**\(7) for a description of ``--submit`` and other common
1574
options.
1575

    
1576
DEACTIVATE-DISKS
1577
^^^^^^^^^^^^^^^^
1578

    
1579
**deactivate-disks** [-f] [\--submit] {*instance*}
1580

    
1581
De-activates the block devices of the given instance. Note that if you
1582
run this command for an instance with a drbd disk template, while it
1583
is running, it will not be able to shutdown the block devices on the
1584
primary node, but it will shutdown the block devices on the secondary
1585
nodes, thus breaking the replication.
1586

    
1587
The ``-f``/``--force`` option will skip checks that the instance is
1588
down; in case the hypervisor is confused and we can't talk to it,
1589
normally Ganeti will refuse to deactivate the disks, but with this
1590
option passed it will skip this check and directly try to deactivate
1591
the disks. This can still fail due to the instance actually running or
1592
other issues.
1593

    
1594
See **ganeti**\(7) for a description of ``--submit`` and other common
1595
options.
1596

    
1597
GROW-DISK
1598
^^^^^^^^^
1599

    
1600
| **grow-disk** [\--no-wait-for-sync] [\--submit] [\--absolute]
1601
| {*instance*} {*disk*} {*amount*}
1602

    
1603
Grows an instance's disk. This is only possible for instances having a
1604
plain, drbd, file, sharedfile, rbd or ext disk template. For the ext
1605
template to work, the ExtStorage provider should also support growing.
1606
This means having a ``grow`` script that actually grows the volume of
1607
the external shared storage.
1608

    
1609
Note that this command only change the block device size; it will not
1610
grow the actual filesystems, partitions, etc. that live on that
1611
disk. Usually, you will need to:
1612

    
1613
#. use **gnt-instance grow-disk**
1614

    
1615
#. reboot the instance (later, at a convenient time)
1616

    
1617
#. use a filesystem resizer, such as **ext2online**\(8) or
1618
   **xfs\_growfs**\(8) to resize the filesystem, or use **fdisk**\(8) to
1619
   change the partition table on the disk
1620

    
1621
The *disk* argument is the index of the instance disk to grow. The
1622
*amount* argument is given as a number which can have a suffix (like the
1623
disk size in instance create); if the suffix is missing, the value will
1624
be interpreted as mebibytes.
1625

    
1626
By default, the *amount* value represents the desired increase in the
1627
disk size (e.g. an amount of 1G will take a disk of size 3G to 4G). If
1628
the optional ``--absolute`` parameter is passed, then the *amount*
1629
argument doesn't represent the delta, but instead the desired final disk
1630
size (e.g. an amount of 8G will take a disk of size 4G to 8G).
1631

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

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

    
1640
See **ganeti**\(7) for a description of ``--submit`` and other common
1641
options.
1642

    
1643
Example (increase the first disk for instance1 by 16GiB)::
1644

    
1645
    # gnt-instance grow-disk instance1.example.com 0 16g
1646

    
1647
Example for increasing the disk size to a certain size::
1648

    
1649
   # gnt-instance grow-disk --absolute instance1.example.com 0 32g
1650

    
1651
Also note that disk shrinking is not supported; use **gnt-backup
1652
export** and then **gnt-backup import** to reduce the disk size of an
1653
instance.
1654

    
1655
RECREATE-DISKS
1656
^^^^^^^^^^^^^^
1657

    
1658
| **recreate-disks** [\--submit]
1659
| [{-n node1:[node2] \| {-I\|\--iallocator *name*}}]
1660
| [\--disk=*N*[:[size=*VAL*][,mode=*ro\|rw*]]] {*instance*}
1661

    
1662
Recreates all or a subset of disks of the given instance.
1663

    
1664
Note that this functionality should only be used for missing disks; if
1665
any of the given disks already exists, the operation will fail.  While
1666
this is suboptimal, recreate-disks should hopefully not be needed in
1667
normal operation and as such the impact of this is low.
1668

    
1669
If only a subset should be recreated, any number of ``disk`` options can
1670
be specified. It expects a disk index and an optional list of disk
1671
parameters to change. Only ``size`` and ``mode`` can be changed while
1672
recreating disks. To recreate all disks while changing parameters on
1673
a subset only, a ``--disk`` option must be given for every disk of the
1674
instance.
1675

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

    
1685
Another method of choosing which nodes to place the instance on is by
1686
using the specified iallocator, passing the ``--iallocator`` option.
1687
The primary and secondary nodes will be chosen by the specified
1688
iallocator plugin, or by the default allocator if ``.`` is specified.
1689

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

    
1693
Recovery/moving
1694
~~~~~~~~~~~~~~~
1695

    
1696
FAILOVER
1697
^^^^^^^^
1698

    
1699
| **failover** [-f] [\--ignore-consistency] [\--ignore-ipolicy]
1700
| [\--shutdown-timeout=*N*]
1701
| [{-n|\--target-node} *node* \| {-I|\--iallocator} *name*]
1702
| [\--submit] [\--cleanup]
1703
| {*instance*}
1704

    
1705
Failover will stop the instance (if running), change its primary node,
1706
and if it was originally running it will start it again (on the new
1707
primary). This works for instances with drbd template (in which case you
1708
can only fail to the secondary node) and for externally mirrored
1709
templates (sharedfile, blockdev, rbd and ext) (in which case you can
1710
fail to any other node).
1711

    
1712
If the instance's disk template is of type sharedfile, blockdev, rbd or
1713
ext, then you can explicitly specify the target node (which can be any
1714
node) using the ``-n`` or ``--target-node`` option, or specify an
1715
iallocator plugin using the ``-I`` or ``--iallocator`` option. If you
1716
omit both, the default iallocator will be used to specify the target
1717
node.
1718

    
1719
If the instance's disk template is of type drbd, the target node is
1720
automatically selected as the drbd's secondary node. Changing the
1721
secondary node is possible with a replace-disks operation.
1722

    
1723
Normally the failover will check the consistency of the disks before
1724
failing over the instance. If you are trying to migrate instances off
1725
a dead node, this will fail. Use the ``--ignore-consistency`` option
1726
for this purpose. Note that this option can be dangerous as errors in
1727
shutting down the instance will be ignored, resulting in possibly
1728
having the instance running on two machines in parallel (on
1729
disconnected DRBD drives).
1730

    
1731
The ``--shutdown-timeout`` is used to specify how much time to wait
1732
before forcing the shutdown (xm destroy in xen, killing the kvm
1733
process, for kvm). By default two minutes are given to each instance
1734
to stop.
1735

    
1736
If ``--ignore-ipolicy`` is given any instance policy violations occuring
1737
during this operation are ignored.
1738

    
1739
If the ``--cleanup`` option is passed, the operation changes from
1740
performin a failover to attempting recovery from a failed previous failover.
1741
In this mode, Ganeti checks if the instance runs on the correct node (and
1742
updates its configuration if not) and ensures the instances' disks
1743
are configured correctly.
1744

    
1745
See **ganeti**\(7) for a description of ``--submit`` and other common
1746
options.
1747

    
1748
Example::
1749

    
1750
    # gnt-instance failover instance1.example.com
1751

    
1752
For externally mirrored templates also ``-n`` is available::
1753

    
1754
    # gnt-instance failover -n node3.example.com instance1.example.com
1755

    
1756

    
1757
MIGRATE
1758
^^^^^^^
1759

    
1760
| **migrate** [-f] [\--allow-failover] [\--non-live]
1761
| [\--migration-mode=live\|non-live] [\--ignore-ipolicy]
1762
| [\--no-runtime-changes] [\--submit]
1763
| [{-n|\--target-node} *node* \| {-I|\--iallocator} *name*] {*instance*}
1764

    
1765
| **migrate** [-f] \--cleanup [\--submit] {*instance*}
1766

    
1767
Migrate will move the instance to its secondary node without shutdown.
1768
As with failover, it works for instances having the drbd disk template
1769
or an externally mirrored disk template type such as sharedfile,
1770
blockdev, rbd or ext.
1771

    
1772
If the instance's disk template is of type sharedfile, blockdev, rbd or
1773
ext, then you can explicitly specify the target node (which can be any
1774
node) using the ``-n`` or ``--target-node`` option, or specify an
1775
iallocator plugin using the ``-I`` or ``--iallocator`` option. If you
1776
omit both, the default iallocator will be used to specify the target
1777
node.  Alternatively, the default iallocator can be requested by
1778
specifying ``.`` as the name of the plugin.
1779

    
1780
If the instance's disk template is of type drbd, the target node is
1781
automatically selected as the drbd's secondary node. Changing the
1782
secondary node is possible with a replace-disks operation.
1783

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

    
1788
The ``--non-live`` and ``--migration-mode=non-live`` options will
1789
switch (for the hypervisors that support it) between a "fully live"
1790
(i.e. the interruption is as minimal as possible) migration and one in
1791
which the instance is frozen, its state saved and transported to the
1792
remote node, and then resumed there. This all depends on the
1793
hypervisor support for two different methods. In any case, it is not
1794
an error to pass this parameter (it will just be ignored if the
1795
hypervisor doesn't support it). The option ``--migration-mode=live``
1796
option will request a fully-live migration. The default, when neither
1797
option is passed, depends on the hypervisor parameters (and can be
1798
viewed with the **gnt-cluster info** command).
1799

    
1800
If the ``--cleanup`` option is passed, the operation changes from
1801
migration to attempting recovery from a failed previous migration. In
1802
this mode, Ganeti checks if the instance runs on the correct node (and
1803
updates its configuration if not) and ensures the instances' disks
1804
are configured correctly. In this mode, the ``--non-live`` option is
1805
ignored.
1806

    
1807
The option ``-f`` will skip the prompting for confirmation.
1808

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

    
1814
If ``--ignore-ipolicy`` is given any instance policy violations occuring
1815
during this operation are ignored.
1816

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

    
1821
If an instance has the backend parameter ``always_failover`` set to
1822
true, then the migration is automatically converted into a failover.
1823

    
1824
See **ganeti**\(7) for a description of ``--submit`` and other common
1825
options.
1826

    
1827
Example (and expected output)::
1828

    
1829
    # gnt-instance migrate instance1
1830
    Instance instance1 will be migrated. Note that migration
1831
    might impact the instance if anything goes wrong (e.g. due to bugs in
1832
    the hypervisor). Continue?
1833
    y/[n]/?: y
1834
    Migrating instance instance1.example.com
1835
    * checking disk consistency between source and target
1836
    * switching node node2.example.com to secondary mode
1837
    * changing into standalone mode
1838
    * changing disks into dual-master mode
1839
    * wait until resync is done
1840
    * preparing node2.example.com to accept the instance
1841
    * migrating instance to node2.example.com
1842
    * switching node node1.example.com to secondary mode
1843
    * wait until resync is done
1844
    * changing into standalone mode
1845
    * changing disks into single-master mode
1846
    * wait until resync is done
1847
    * done
1848
    #
1849

    
1850

    
1851
MOVE
1852
^^^^
1853

    
1854
| **move** [-f] [\--ignore-consistency]
1855
| [-n *node*] [\--shutdown-timeout=*N*] [\--submit] [\--ignore-ipolicy]
1856
| {*instance*}
1857

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

    
1861
Note that since this operation is done via data copy, it will take a
1862
long time for big disks (similar to replace-disks for a drbd
1863
instance).
1864

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

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

    
1874
If ``--ignore-ipolicy`` is given any instance policy violations occuring
1875
during this operation are ignored.
1876

    
1877
See **ganeti**\(7) for a description of ``--submit`` and other common
1878
options.
1879

    
1880
Example::
1881

    
1882
    # gnt-instance move -n node3.example.com instance1.example.com
1883

    
1884

    
1885
CHANGE-GROUP
1886
^^^^^^^^^^^^
1887

    
1888
| **change-group** [\--submit]
1889
| [\--iallocator *NAME*] [\--to *GROUP*...] {*instance*}
1890

    
1891
This command moves an instance to another node group. The move is
1892
calculated by an iallocator, either given on the command line or as a
1893
cluster default.
1894

    
1895
If no specific destination groups are specified using ``--to``, all
1896
groups except the one containing the instance are considered.
1897

    
1898
See **ganeti**\(7) for a description of ``--submit`` and other common
1899
options.
1900

    
1901
Example::
1902

    
1903
    # gnt-instance change-group -I hail --to rack2 inst1.example.com
1904

    
1905

    
1906
Tags
1907
~~~~
1908

    
1909
ADD-TAGS
1910
^^^^^^^^
1911

    
1912
**add-tags** [\--from *file*] {*instancename*} {*tag*...}
1913

    
1914
Add tags to the given instance. If any of the tags contains invalid
1915
characters, the entire operation will abort.
1916

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

    
1923
LIST-TAGS
1924
^^^^^^^^^
1925

    
1926
**list-tags** {*instancename*}
1927

    
1928
List the tags of the given instance.
1929

    
1930
REMOVE-TAGS
1931
^^^^^^^^^^^
1932

    
1933
**remove-tags** [\--from *file*] {*instancename*} {*tag*...}
1934

    
1935
Remove tags from the given instance. If any of the tags are not
1936
existing on the node, the entire operation will abort.
1937

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

    
1944
.. vim: set textwidth=72 :
1945
.. Local Variables:
1946
.. mode: rst
1947
.. fill-column: 72
1948
.. End: