Statistics
| Branch: | Tag: | Revision:

root / man / gnt-instance.rst @ 4c6e8e1a

History | View | Annotate | Download (70.5 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

    
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
blktap2
848
    Analogous to the blktap driver, but used by newer versions of Xen.
849

    
850
If ``--ignore-ipolicy`` is given any instance policy violations occuring
851
during this operation are ignored.
852

    
853
See **ganeti**\(7) for a description of ``--submit`` and other common
854
options.
855

    
856
Example::
857

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

    
874

    
875
BATCH-CREATE
876
^^^^^^^^^^^^
877

    
878
| **batch-create**
879
| [{-I|\--iallocator} *instance allocator*]
880
| {instances\_file.json}
881

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

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

    
894
instance\_name
895
    The FQDN of the new instance.
896

    
897
disk\_template
898
    The disk template to use for the instance, the same as in the
899
    **add** command.
900

    
901
disks
902
    Array of disk specifications. Each entry describes one disk as a
903
    dictionary of disk parameters.
904

    
905
beparams
906
    A dictionary of backend parameters.
907

    
908
hypervisor
909
    The hypervisor for the instance.
910

    
911
hvparams
912
    A dictionary with the hypervisor options. If not passed, the default
913
    hypervisor options will be inherited.
914

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

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

    
927
start
928
    whether to start the instance
929

    
930
ip\_check
931
    Skip the check for already-in-use instance; see the description in
932
    the **add** command for details.
933

    
934
name\_check
935
    Skip the name check for instances; see the description in the
936
    **add** command for details.
937

    
938
file\_storage\_dir, file\_driver
939
    Configuration for the file disk type, see the **add** command for
940
    details.
941

    
942

    
943
A simple definition for one instance can be (with most of the
944
parameters taken from the cluster defaults)::
945

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

    
969
The command will display the job id for each submitted instance, as
970
follows::
971

    
972
    # gnt-instance batch-create instances.json
973
    Submitted jobs 37, 38
974

    
975
REMOVE
976
^^^^^^
977

    
978
**remove** [\--ignore-failures] [\--shutdown-timeout=*N*] [\--submit]
979
[\--force] {*instance*}
980

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

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

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

    
996
The ``--force`` option is used to skip the interactive confirmation.
997

    
998
See **ganeti**\(7) for a description of ``--submit`` and other common
999
options.
1000

    
1001
Example::
1002

    
1003
    # gnt-instance remove instance1.example.com
1004

    
1005

    
1006
LIST
1007
^^^^
1008

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

    
1013
Shows the currently configured instances with memory usage, disk
1014
usage, the node they are running on, and their run status.
1015

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

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

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

    
1031
The ``-o (--output)`` option takes a comma-separated list of output
1032
fields. The available fields and their meaning are:
1033

    
1034
@QUERY_FIELDS_INSTANCE@
1035

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

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

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

    
1056
The default output field list is: ``name``, ``os``, ``pnode``,
1057
``admin_state``, ``oper_state``, ``oper_ram``.
1058

    
1059

    
1060
LIST-FIELDS
1061
^^^^^^^^^^^
1062

    
1063
**list-fields** [field...]
1064

    
1065
Lists available fields for instances.
1066

    
1067

    
1068
INFO
1069
^^^^
1070

    
1071
**info** [-s \| \--static] [\--roman] {\--all \| *instance*}
1072

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

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

    
1081
Use the ``--all`` to get info about all instances, rather than
1082
explicitly passing the ones you're interested in.
1083

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

    
1088
MODIFY
1089
^^^^^^
1090

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

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

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

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

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

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

    
1151
mode
1152
  The access mode. Either ``ro`` (read-only) or the default ``rw`` (read-write).
1153

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

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

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

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

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

    
1184
If ``--ignore-ipolicy`` is given any instance policy violations occuring
1185
during this operation are ignored.
1186

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

    
1197
See **ganeti**\(7) for a description of ``--submit`` and other common
1198
options.
1199

    
1200
Most of the changes take effect at the next restart. If the instance is
1201
running, there is no effect on the instance.
1202

    
1203
REINSTALL
1204
^^^^^^^^^
1205

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

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

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

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

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

    
1231
RENAME
1232
^^^^^^
1233

    
1234
| **rename** [\--no-ip-check] [\--no-name-check] [\--submit]
1235
| {*instance*} {*new\_name*}
1236

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

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

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

    
1254
See **ganeti**\(7) for a description of ``--submit`` and other common
1255
options.
1256

    
1257
Starting/stopping/connecting to console
1258
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1259

    
1260
STARTUP
1261
^^^^^^^
1262

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

    
1273
Starts one or more instances, depending on the following options.  The
1274
four available modes are:
1275

    
1276
\--instance
1277
    will start the instances given as arguments (at least one argument
1278
    required); this is the default selection
1279

    
1280
\--node
1281
    will start the instances who have the given node as either primary
1282
    or secondary
1283

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

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

    
1292
\--all
1293
    will start all instances in the cluster (no arguments accepted)
1294

    
1295
\--tags
1296
    will start all instances in the cluster with the tags given as
1297
    arguments
1298

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

    
1303
\--pri-node-tags
1304
    will start all instances in the cluster on primary nodes with the
1305
    tags given as arguments
1306

    
1307
\--sec-node-tags
1308
    will start all instances in the cluster on secondary nodes with the
1309
    tags given as arguments
1310

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

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

    
1319
The ``--force-multiple`` will skip the interactive confirmation in the
1320
case the more than one instance will be affected.
1321

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

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

    
1334
    # gnt-instance start -H kernel_args="single" instance1
1335
    # gnt-instance start -B maxmem=2048 instance2
1336

    
1337

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

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

    
1350
See **ganeti**\(7) for a description of ``--submit`` and other common
1351
options.
1352

    
1353
Example::
1354

    
1355
    # gnt-instance start instance1.example.com
1356
    # gnt-instance start --node node1.example.com node2.example.com
1357
    # gnt-instance start --all
1358

    
1359

    
1360
SHUTDOWN
1361
^^^^^^^^
1362

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

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

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

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

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

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

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

    
1403
See **ganeti**\(7) for a description of ``--submit`` and other common
1404
options.
1405

    
1406
Example::
1407

    
1408
    # gnt-instance shutdown instance1.example.com
1409
    # gnt-instance shutdown --all
1410

    
1411

    
1412
REBOOT
1413
^^^^^^
1414

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

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

    
1432
For the hard reboot the option ``--ignore-secondaries`` ignores errors
1433
for the secondary node while re-assembling the instance disks.
1434

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

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

    
1445
The ``--force-multiple`` will skip the interactive confirmation in the
1446
case the more than one instance will be affected.
1447

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

    
1451
Example::
1452

    
1453
    # gnt-instance reboot instance1.example.com
1454
    # gnt-instance reboot --type=full instance1.example.com
1455

    
1456

    
1457
CONSOLE
1458
^^^^^^^
1459

    
1460
**console** [\--show-cmd] {*instance*}
1461

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

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

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

    
1475
Example::
1476

    
1477
    # gnt-instance console instance1.example.com
1478

    
1479

    
1480
Disk management
1481
~~~~~~~~~~~~~~~
1482

    
1483
REPLACE-DISKS
1484
^^^^^^^^^^^^^
1485

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

    
1489
**replace-disks** [\--submit] [\--early-release] [\--ignore-ipolicy] {-s}
1490
[\--disks *idx*] {*instance*}
1491

    
1492
**replace-disks** [\--submit] [\--early-release] [\--ignore-ipolicy]
1493
{{-I\|\--iallocator} *name* \| {{-n|\--new-secondary} *node* } {*instance*}
1494

    
1495
**replace-disks** [\--submit] [\--early-release] [\--ignore-ipolicy]
1496
{-a\|\--auto} {*instance*}
1497

    
1498
This command is a generalized form for replacing disks. It is
1499
currently only valid for the mirrored (DRBD) disk template.
1500

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

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

    
1516
Note that it is not possible to select an offline or drained node as a
1517
new secondary.
1518

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

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

    
1534
The ``--ignore-ipolicy`` let the command ignore instance policy
1535
violations if replace-disks changes groups and the instance would
1536
violate the new groups instance policy.
1537

    
1538
See **ganeti**\(7) for a description of ``--submit`` and other common
1539
options.
1540

    
1541
ACTIVATE-DISKS
1542
^^^^^^^^^^^^^^
1543

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

    
1546
Activates the block devices of the given instance. If successful, the
1547
command will show the location and name of the block devices::
1548

    
1549
    node1.example.com:disk/0:/dev/drbd0
1550
    node1.example.com:disk/1:/dev/drbd1
1551

    
1552

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

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

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

    
1573
Note that it is safe to run this command while the instance is already
1574
running.
1575

    
1576
See **ganeti**\(7) for a description of ``--submit`` and other common
1577
options.
1578

    
1579
DEACTIVATE-DISKS
1580
^^^^^^^^^^^^^^^^
1581

    
1582
**deactivate-disks** [-f] [\--submit] {*instance*}
1583

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

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

    
1597
See **ganeti**\(7) for a description of ``--submit`` and other common
1598
options.
1599

    
1600
GROW-DISK
1601
^^^^^^^^^
1602

    
1603
| **grow-disk** [\--no-wait-for-sync] [\--submit] [\--absolute]
1604
| {*instance*} {*disk*} {*amount*}
1605

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

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

    
1616
#. use **gnt-instance grow-disk**
1617

    
1618
#. reboot the instance (later, at a convenient time)
1619

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

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

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

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

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

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

    
1646
Example (increase the first disk for instance1 by 16GiB)::
1647

    
1648
    # gnt-instance grow-disk instance1.example.com 0 16g
1649

    
1650
Example for increasing the disk size to a certain size::
1651

    
1652
   # gnt-instance grow-disk --absolute instance1.example.com 0 32g
1653

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

    
1658
RECREATE-DISKS
1659
^^^^^^^^^^^^^^
1660

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

    
1665
Recreates all or a subset of disks of the given instance.
1666

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

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

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

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

    
1693
See **ganeti**\(7) for a description of ``--submit`` and other common
1694
options.
1695

    
1696
Recovery/moving
1697
~~~~~~~~~~~~~~~
1698

    
1699
FAILOVER
1700
^^^^^^^^
1701

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

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

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

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

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

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

    
1739
If ``--ignore-ipolicy`` is given any instance policy violations occuring
1740
during this operation are ignored.
1741

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

    
1748
See **ganeti**\(7) for a description of ``--submit`` and other common
1749
options.
1750

    
1751
Example::
1752

    
1753
    # gnt-instance failover instance1.example.com
1754

    
1755
For externally mirrored templates also ``-n`` is available::
1756

    
1757
    # gnt-instance failover -n node3.example.com instance1.example.com
1758

    
1759

    
1760
MIGRATE
1761
^^^^^^^
1762

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

    
1768
| **migrate** [-f] \--cleanup [\--submit] {*instance*}
1769

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

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

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

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

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

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

    
1810
The option ``-f`` will skip the prompting for confirmation.
1811

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

    
1817
If ``--ignore-ipolicy`` is given any instance policy violations occuring
1818
during this operation are ignored.
1819

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

    
1824
If an instance has the backend parameter ``always_failover`` set to
1825
true, then the migration is automatically converted into a failover.
1826

    
1827
See **ganeti**\(7) for a description of ``--submit`` and other common
1828
options.
1829

    
1830
Example (and expected output)::
1831

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

    
1853

    
1854
MOVE
1855
^^^^
1856

    
1857
| **move** [-f] [\--ignore-consistency]
1858
| [-n *node*] [\--shutdown-timeout=*N*] [\--submit] [\--ignore-ipolicy]
1859
| {*instance*}
1860

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

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

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

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

    
1877
If ``--ignore-ipolicy`` is given any instance policy violations occuring
1878
during this operation are ignored.
1879

    
1880
See **ganeti**\(7) for a description of ``--submit`` and other common
1881
options.
1882

    
1883
Example::
1884

    
1885
    # gnt-instance move -n node3.example.com instance1.example.com
1886

    
1887

    
1888
CHANGE-GROUP
1889
^^^^^^^^^^^^
1890

    
1891
| **change-group** [\--submit]
1892
| [\--iallocator *NAME*] [\--to *GROUP*...] {*instance*}
1893

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

    
1898
If no specific destination groups are specified using ``--to``, all
1899
groups except the one containing the instance are considered.
1900

    
1901
See **ganeti**\(7) for a description of ``--submit`` and other common
1902
options.
1903

    
1904
Example::
1905

    
1906
    # gnt-instance change-group -I hail --to rack2 inst1.example.com
1907

    
1908

    
1909
Tags
1910
~~~~
1911

    
1912
ADD-TAGS
1913
^^^^^^^^
1914

    
1915
**add-tags** [\--from *file*] {*instancename*} {*tag*...}
1916

    
1917
Add tags to the given instance. If any of the tags contains invalid
1918
characters, the entire operation will abort.
1919

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

    
1926
LIST-TAGS
1927
^^^^^^^^^
1928

    
1929
**list-tags** {*instancename*}
1930

    
1931
List the tags of the given instance.
1932

    
1933
REMOVE-TAGS
1934
^^^^^^^^^^^
1935

    
1936
**remove-tags** [\--from *file*] {*instancename*} {*tag*...}
1937

    
1938
Remove tags from the given instance. If any of the tags are not
1939
existing on the node, the entire operation will abort.
1940

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

    
1947
.. vim: set textwidth=72 :
1948
.. Local Variables:
1949
.. mode: rst
1950
.. fill-column: 72
1951
.. End: