Statistics
| Branch: | Tag: | Revision:

root / man / gnt-instance.rst @ 7ed400f0

History | View | Annotate | Download (58.2 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*}[,vg=*VG*][,metavg=*VG*][,mode=*ro\|rw*]
32
|  \| {-s|--os-size} *SIZE*}
33
| [--no-ip-check] [--no-name-check] [--no-start] [--no-install]
34
| [--net=*N* [:options...] \| --no-nics]
35
| [{-B|--backend-parameters} *BEPARAMS*]
36
| [{-H|--hypervisor-parameters} *HYPERVISOR* [: option=*value*... ]]
37
| [{-O|--os-parameters} *param*=*value*... ]
38
| [--file-storage-dir *dir\_path*] [--file-driver {loop \| blktap}]
39
| {{-n|--node} *node[:secondary-node]* \| {-I|--iallocator} *name*}
40
| {{-o|--os-type} *os-type*}
41
| [--submit]
42
| [--ignore-ipolicy]
43
| {*instance*}
44

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

    
49
The ``disk`` option specifies the parameters for the disks of the
50
instance. The numbering of disks starts at zero, and at least one disk
51
needs to be passed. For each disk, either the size or the adoption
52
source needs to be given, and optionally the access mode (read-only or
53
the default of read-write) and the LVM volume group can also be
54
specified (via the ``vg`` key). For DRBD devices, a different VG can
55
be specified for the metadata device using the ``metavg`` key.  The
56
size is interpreted (when no unit is given) in mebibytes. You can also
57
use one of the suffixes *m*, *g* or *t* to specify the exact the units
58
used; these suffixes map to mebibytes, gibibytes and tebibytes.
59

    
60
When using the ``adopt`` key in the disk definition, Ganeti will
61
reuse those volumes (instead of creating new ones) as the
62
instance's disks. Ganeti will rename these volumes to the standard
63
format, and (without installing the OS) will use them as-is for the
64
instance. This allows migrating instances from non-managed mode
65
(e.g. plain KVM with LVM) to being managed via Ganeti. Please note that
66
this works only for the \`plain' disk template (see below for
67
template details).
68

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

    
73
The minimum disk specification is therefore ``--disk 0:size=20G`` (or
74
``-s 20G`` when using the ``-s`` option), and a three-disk instance
75
can be specified as ``--disk 0:size=20G --disk 1:size=4G --disk
76
2:size=100G``.
77

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

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

    
87
If you don't wat the instance to automatically start after
88
creation, this is possible via the ``--no-start`` option. This will
89
leave the instance down until a subsequent **gnt-instance start**
90
command.
91

    
92
The NICs of the instances can be specified via the ``--net``
93
option. By default, one NIC is created for the instance, with a
94
random MAC, and set up according the the cluster level nic
95
parameters. Each NIC can take these parameters (all optional):
96

    
97
mac
98
    either a value or 'generate' to generate a new unique MAC
99

    
100
ip
101
    specifies the IP address assigned to the instance from the Ganeti
102
    side (this is not necessarily what the instance will use, but what
103
    the node expects the instance to use)
104

    
105
mode
106
    specifies the connection mode for this nic: routed or bridged.
107

    
108
link
109
    in bridged mode specifies the bridge to attach this NIC to, in
110
    routed mode it's intended to differentiate between different
111
    routing tables/instance groups (but the meaning is dependent on
112
    the network script, see gnt-cluster(8) for more details)
113

    
114

    
115
Of these "mode" and "link" are nic parameters, and inherit their
116
default at cluster level.  Alternatively, if no network is desired for
117
the instance, you can prevent the default of one NIC with the
118
``--no-nics`` option.
119

    
120
The ``-o (--os-type)`` option specifies the operating system to be
121
installed.  The available operating systems can be listed with
122
**gnt-os list**.  Passing ``--no-install`` will however skip the OS
123
installation, allowing a manual import if so desired. Note that the
124
no-installation mode will automatically disable the start-up of the
125
instance (without an OS, it most likely won't be able to start-up
126
successfully).
127

    
128
The ``-B (--backend-parameters)`` option specifies the backend
129
parameters for the instance. If no such parameters are specified, the
130
values are inherited from the cluster. Possible parameters are:
131

    
132
maxmem
133
    the maximum memory size of the instance; as usual, suffixes can be
134
    used to denote the unit, otherwise the value is taken in mebibytes
135

    
136
minmem
137
    the minimum memory size of the instance; as usual, suffixes can be
138
    used to denote the unit, otherwise the value is taken in mebibytes
139

    
140
vcpus
141
    the number of VCPUs to assign to the instance (if this value makes
142
    sense for the hypervisor)
143

    
144
auto\_balance
145
    whether the instance is considered in the N+1 cluster checks
146
    (enough redundancy in the cluster to survive a node failure)
147

    
148
always\_failover
149
    ``True`` or ``False``, whether the instance must be failed over
150
    (shut down and rebooted) always or it may be migrated (briefly
151
    suspended)
152

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

    
159
The ``-H (--hypervisor-parameters)`` option specified the hypervisor
160
to use for the instance (must be one of the enabled hypervisors on the
161
cluster) and optionally custom parameters for this instance. If not
162
other options are used (i.e. the invocation is just -H *NAME*) the
163
instance will inherit the cluster options. The defaults below show the
164
cluster defaults at cluster creation time.
165

    
166
The possible hypervisor options are as follows:
167

    
168
boot\_order
169
    Valid for the Xen HVM and KVM hypervisors.
170

    
171
    A string value denoting the boot order. This has different meaning
172
    for the Xen HVM hypervisor and for the KVM one.
173

    
174
    For Xen HVM, The boot order is a string of letters listing the boot
175
    devices, with valid device letters being:
176

    
177
    a
178
        floppy drive
179

    
180
    c
181
        hard disk
182

    
183
    d
184
        CDROM drive
185

    
186
    n
187
        network boot (PXE)
188

    
189
    The default is not to set an HVM boot order, which is interpreted
190
    as 'dc'.
191

    
192
    For KVM the boot order is either "floppy", "cdrom", "disk" or
193
    "network".  Please note that older versions of KVM couldn't
194
    netboot from virtio interfaces. This has been fixed in more recent
195
    versions and is confirmed to work at least with qemu-kvm 0.11.1.
196

    
197
blockdev\_prefix
198
    Valid for the Xen HVM and PVM hypervisors.
199

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

    
204
floppy\_image\_path
205
    Valid for the KVM hypervisor.
206

    
207
    The path to a floppy disk image to attach to the instance.  This
208
    is useful to install Windows operating systems on Virt/IO disks
209
    because you can specify here the floppy for the drivers at
210
    installation time.
211

    
212
cdrom\_image\_path
213
    Valid for the Xen HVM and KVM hypervisors.
214

    
215
    The path to a CDROM image to attach to the instance.
216

    
217
cdrom2\_image\_path
218
    Valid for the KVM hypervisor.
219

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

    
224
nic\_type
225
    Valid for the Xen HVM and KVM hypervisors.
226

    
227
    This parameter determines the way the network cards are presented
228
    to the instance. The possible options are:
229

    
230
    - rtl8139 (default for Xen HVM) (HVM & KVM)
231
    - ne2k\_isa (HVM & KVM)
232
    - ne2k\_pci (HVM & KVM)
233
    - i82551 (KVM)
234
    - i82557b (KVM)
235
    - i82559er (KVM)
236
    - pcnet (KVM)
237
    - e1000 (KVM)
238
    - paravirtual (default for KVM) (HVM & KVM)
239

    
240
disk\_type
241
    Valid for the Xen HVM and KVM hypervisors.
242

    
243
    This parameter determines the way the disks are presented to the
244
    instance. The possible options are:
245

    
246
    - ioemu [default] (HVM & KVM)
247
    - ide (HVM & KVM)
248
    - scsi (KVM)
249
    - sd (KVM)
250
    - mtd (KVM)
251
    - pflash (KVM)
252

    
253

    
254
cdrom\_disk\_type
255
    Valid for the KVM hypervisor.
256

    
257
    This parameter determines the way the cdroms disks are presented
258
    to the instance. The default behavior is to get the same value of
259
    the eariler parameter (disk_type). The possible options are:
260

    
261
    - paravirtual
262
    - ide
263
    - scsi
264
    - sd
265
    - mtd
266
    - pflash
267

    
268

    
269
vnc\_bind\_address
270
    Valid for the Xen HVM and KVM hypervisors.
271

    
272
    Specifies the address that the VNC listener for this instance
273
    should bind to. Valid values are IPv4 addresses. Use the address
274
    0.0.0.0 to bind to all available interfaces (this is the default)
275
    or specify the address of one of the interfaces on the node to
276
    restrict listening to that interface.
277

    
278
vnc\_tls
279
    Valid for the KVM hypervisor.
280

    
281
    A boolean option that controls whether the VNC connection is
282
    secured with TLS.
283

    
284
vnc\_x509\_path
285
    Valid for the KVM hypervisor.
286

    
287
    If ``vnc_tls`` is enabled, this options specifies the path to the
288
    x509 certificate to use.
289

    
290
vnc\_x509\_verify
291
    Valid for the KVM hypervisor.
292

    
293
spice\_bind
294
    Valid for the KVM hypervisor.
295

    
296
    Specifies the address or interface on which the SPICE server will
297
    listen. Valid values are:
298

    
299
    - IPv4 addresses, including 0.0.0.0 and 127.0.0.1
300
    - IPv6 addresses, including :: and ::1
301
    - names of network interfaces
302

    
303
    If a network interface is specified, the SPICE server will be bound
304
    to one of the addresses of that interface.
305

    
306
spice\_ip\_version
307
    Valid for the KVM hypervisor.
308

    
309
    Specifies which version of the IP protocol should be used by the
310
    SPICE server.
311

    
312
    It is mainly intended to be used for specifying what kind of IP
313
    addresses should be used if a network interface with both IPv4 and
314
    IPv6 addresses is specified via the ``spice_bind`` parameter. In
315
    this case, if the ``spice_ip_version`` parameter is not used, the
316
    default IP version of the cluster will be used.
317

    
318
spice\_password\_file
319
    Valid for the KVM hypervisor.
320

    
321
    Specifies a file containing the password that must be used when
322
    connecting via the SPICE protocol. If the option is not specified,
323
    passwordless connections are allowed.
324

    
325
spice\_image\_compression
326
    Valid for the KVM hypervisor.
327

    
328
    Configures the SPICE lossless image compression. Valid values are:
329

    
330
    - auto_glz
331
    - auto_lz
332
    - quic
333
    - glz
334
    - lz
335
    - off
336

    
337
spice\_jpeg\_wan\_compression
338
    Valid for the KVM hypervisor.
339

    
340
    Configures how SPICE should use the jpeg algorithm for lossy image
341
    compression on slow links. Valid values are:
342

    
343
    - auto
344
    - never
345
    - always
346

    
347
spice\_zlib\_glz\_wan\_compression
348
    Valid for the KVM hypervisor.
349

    
350
    Configures how SPICE should use the zlib-glz algorithm for lossy image
351
    compression on slow links. Valid values are:
352

    
353
    - auto
354
    - never
355
    - always
356

    
357
spice\_streaming\_video
358
    Valid for the KVM hypervisor.
359

    
360
    Configures how SPICE should detect video streams. Valid values are:
361

    
362
    - off
363
    - all
364
    - filter
365

    
366
spice\_playback\_compression
367
    Valid for the KVM hypervisor.
368

    
369
    Configures whether SPICE should compress audio streams or not.
370

    
371
spice\_use\_tls
372
    Valid for the KVM hypervisor.
373

    
374
    Specifies that the SPICE server must use TLS to encrypt all the
375
    traffic with the client.
376

    
377
spice\_tls\_ciphers
378
    Valid for the KVM hypervisor.
379

    
380
    Specifies a list of comma-separated ciphers that SPICE should use
381
    for TLS connections. For the format, see man cipher(1).
382

    
383
spice\_use\_vdagent
384
    Valid for the KVM hypervisor.
385

    
386
    Enables or disables passing mouse events via SPICE vdagent.
387

    
388
acpi
389
    Valid for the Xen HVM and KVM hypervisors.
390

    
391
    A boolean option that specifies if the hypervisor should enable
392
    ACPI support for this instance. By default, ACPI is disabled.
393

    
394
pae
395
    Valid for the Xen HVM and KVM hypervisors.
396

    
397
    A boolean option that specifies if the hypervisor should enabled
398
    PAE support for this instance. The default is false, disabling PAE
399
    support.
400

    
401
use\_localtime
402
    Valid for the Xen HVM and KVM hypervisors.
403

    
404
    A boolean option that specifies if the instance should be started
405
    with its clock set to the localtime of the machine (when true) or
406
    to the UTC (When false). The default is false, which is useful for
407
    Linux/Unix machines; for Windows OSes, it is recommended to enable
408
    this parameter.
409

    
410
kernel\_path
411
    Valid for the Xen PVM and KVM hypervisors.
412

    
413
    This option specifies the path (on the node) to the kernel to boot
414
    the instance with. Xen PVM instances always require this, while
415
    for KVM if this option is empty, it will cause the machine to load
416
    the kernel from its disks.
417

    
418
kernel\_args
419
    Valid for the Xen PVM and KVM hypervisors.
420

    
421
    This options specifies extra arguments to the kernel that will be
422
    loaded. device. This is always used for Xen PVM, while for KVM it
423
    is only used if the ``kernel_path`` option is also specified.
424

    
425
    The default setting for this value is simply ``"ro"``, which
426
    mounts the root disk (initially) in read-only one. For example,
427
    setting this to single will cause the instance to start in
428
    single-user mode.
429

    
430
initrd\_path
431
    Valid for the Xen PVM and KVM hypervisors.
432

    
433
    This option specifies the path (on the node) to the initrd to boot
434
    the instance with. Xen PVM instances can use this always, while
435
    for KVM if this option is only used if the ``kernel_path`` option
436
    is also specified. You can pass here either an absolute filename
437
    (the path to the initrd) if you want to use an initrd, or use the
438
    format no\_initrd\_path for no initrd.
439

    
440
root\_path
441
    Valid for the Xen PVM and KVM hypervisors.
442

    
443
    This options specifies the name of the root device. This is always
444
    needed for Xen PVM, while for KVM it is only used if the
445
    ``kernel_path`` option is also specified.
446

    
447
    Please note, that if this setting is an empty string and the
448
    hypervisor is Xen it will not be written to the Xen configuration
449
    file
450

    
451
serial\_console
452
    Valid for the KVM hypervisor.
453

    
454
    This boolean option specifies whether to emulate a serial console
455
    for the instance.
456

    
457
disk\_cache
458
    Valid for the KVM hypervisor.
459

    
460
    The disk cache mode. It can be either default to not pass any
461
    cache option to KVM, or one of the KVM cache modes: none (for
462
    direct I/O), writethrough (to use the host cache but report
463
    completion to the guest only when the host has committed the
464
    changes to disk) or writeback (to use the host cache and report
465
    completion as soon as the data is in the host cache). Note that
466
    there are special considerations for the cache mode depending on
467
    version of KVM used and disk type (always raw file under Ganeti),
468
    please refer to the KVM documentation for more details.
469

    
470
security\_model
471
    Valid for the KVM hypervisor.
472

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

    
477
    Under *user* kvm will drop privileges and become the user
478
    specified by the security\_domain parameter.
479

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

    
484
security\_domain
485
    Valid for the KVM hypervisor.
486

    
487
    Under security model *user* the username to run the instance
488
    under.  It must be a valid username existing on the host.
489

    
490
    Cannot be set under security model *none* or *pool*.
491

    
492
kvm\_flag
493
    Valid for the KVM hypervisor.
494

    
495
    If *enabled* the -enable-kvm flag is passed to kvm. If *disabled*
496
    -disable-kvm is passed. If unset no flag is passed, and the
497
    default running mode for your kvm binary will be used.
498

    
499
mem\_path
500
    Valid for the KVM hypervisor.
501

    
502
    This option passes the -mem-path argument to kvm with the path (on
503
    the node) to the mount point of the hugetlbfs file system, along
504
    with the -mem-prealloc argument too.
505

    
506
use\_chroot
507
    Valid for the KVM hypervisor.
508

    
509
    This boolean option determines wether to run the KVM instance in a
510
    chroot directory.
511

    
512
    If it is set to ``true``, an empty directory is created before
513
    starting the instance and its path is passed via the -chroot flag
514
    to kvm. The directory is removed when the instance is stopped.
515

    
516
    It is set to ``false`` by default.
517

    
518
migration\_downtime
519
    Valid for the KVM hypervisor.
520

    
521
    The maximum amount of time (in ms) a KVM instance is allowed to be
522
    frozen during a live migration, in order to copy dirty memory
523
    pages. Default value is 30ms, but you may need to increase this
524
    value for busy instances.
525

    
526
    This option is only effective with kvm versions >= 87 and qemu-kvm
527
    versions >= 0.11.0.
528

    
529
cpu\_mask
530
    Valid for the LXC hypervisor.
531

    
532
    The processes belonging to the given instance are only scheduled
533
    on the specified CPUs.
534

    
535
    The parameter format is a comma-separated list of CPU IDs or CPU
536
    ID ranges. The ranges are defined by a lower and higher boundary,
537
    separated by a dash. The boundaries are inclusive.
538

    
539
usb\_mouse
540
    Valid for the KVM hypervisor.
541

    
542
    This option specifies the usb mouse type to be used. It can be
543
    "mouse" or "tablet". When using VNC it's recommended to set it to
544
    "tablet".
545

    
546
keymap
547
    Valid for the KVM hypervisor.
548

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

    
552
reboot\_behavior
553
    Valid for Xen PVM, Xen HVM and KVM hypervisors.
554

    
555
    Normally if an instance reboots, the hypervisor will restart it. If
556
    this option is set to ``exit``, the hypervisor will treat a reboot
557
    as a shutdown instead.
558

    
559
    It is set to ``reboot`` by default.
560

    
561

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

    
567
    gnt-instance add -O dhcp=yes ...
568

    
569
The ``-I (--iallocator)`` option specifies the instance allocator
570
plugin to use. If you pass in this option the allocator will select
571
nodes for this instance automatically, so you don't need to pass them
572
with the ``-n`` option. For more information please refer to the
573
instance allocator documentation.
574

    
575
The ``-t (--disk-template)`` options specifies the disk layout type
576
for the instance.  The available choices are:
577

    
578
diskless
579
    This creates an instance with no disks. Its useful for testing only
580
    (or other special cases).
581

    
582
file
583
    Disk devices will be regular files.
584

    
585
plain
586
    Disk devices will be logical volumes.
587

    
588
drbd
589
    Disk devices will be drbd (version 8.x) on top of lvm volumes.
590

    
591
rbd
592
    Disk devices will be rbd volumes residing inside a RADOS cluster.
593

    
594

    
595
The optional second value of the ``-n (--node)`` is used for the drbd
596
template type and specifies the remote node.
597

    
598
If you do not want gnt-instance to wait for the disk mirror to be
599
synced, use the ``--no-wait-for-sync`` option.
600

    
601
The ``--file-storage-dir`` specifies the relative path under the
602
cluster-wide file storage directory to store file-based disks. It is
603
useful for having different subdirectories for different
604
instances. The full path of the directory where the disk files are
605
stored will consist of cluster-wide file storage directory + optional
606
subdirectory + instance name. Example:
607
``@RPL_FILE_STORAGE_DIR@``*/mysubdir/instance1.example.com*. This
608
option is only relevant for instances using the file storage backend.
609

    
610
The ``--file-driver`` specifies the driver to use for file-based
611
disks. Note that currently these drivers work with the xen hypervisor
612
only. This option is only relevant for instances using the file
613
storage backend. The available choices are:
614

    
615
loop
616
    Kernel loopback driver. This driver uses loopback devices to
617
    access the filesystem within the file. However, running I/O
618
    intensive applications in your instance using the loop driver
619
    might result in slowdowns. Furthermore, if you use the loopback
620
    driver consider increasing the maximum amount of loopback devices
621
    (on most systems it's 8) using the max\_loop param.
622

    
623
blktap
624
    The blktap driver (for Xen hypervisors). In order to be able to
625
    use the blktap driver you should check if the 'blktapctrl' user
626
    space disk agent is running (usually automatically started via
627
    xend).  This user-level disk I/O interface has the advantage of
628
    better performance. Especially if you use a network file system
629
    (e.g. NFS) to store your instances this is the recommended choice.
630

    
631

    
632
The ``--submit`` option is used to send the job to the master daemon
633
but not wait for its completion. The job ID will be shown so that it
634
can be examined via **gnt-job info**.
635

    
636
If ``--ignore-ipolicy`` is given any instance policy violations occuring
637
during this operation are ignored.
638

    
639
Example::
640

    
641
    # gnt-instance add -t file --disk 0:size=30g -B maxmem=512 -o debian-etch \
642
      -n node1.example.com --file-storage-dir=mysubdir instance1.example.com
643
    # gnt-instance add -t plain --disk 0:size=30g -B maxmem=1024,minmem=512 \
644
      -o debian-etch -n node1.example.com instance1.example.com
645
    # gnt-instance add -t plain --disk 0:size=30g --disk 1:size=100g,vg=san \
646
      -B maxmem=512 -o debian-etch -n node1.example.com instance1.example.com
647
    # gnt-instance add -t drbd --disk 0:size=30g -B maxmem=512 -o debian-etch \
648
      -n node1.example.com:node2.example.com instance2.example.com
649

    
650

    
651
BATCH-CREATE
652
^^^^^^^^^^^^
653

    
654
**batch-create** {instances\_file.json}
655

    
656
This command (similar to the Ganeti 1.2 **batcher** tool) submits
657
multiple instance creation jobs based on a definition file. The
658
instance configurations do not encompass all the possible options for
659
the **add** command, but only a subset.
660

    
661
The instance file should be a valid-formed JSON file, containing a
662
dictionary with instance name and instance parameters. The accepted
663
parameters are:
664

    
665
disk\_size
666
    The size of the disks of the instance.
667

    
668
disk\_template
669
    The disk template to use for the instance, the same as in the
670
    **add** command.
671

    
672
backend
673
    A dictionary of backend parameters.
674

    
675
hypervisor
676
    A dictionary with a single key (the hypervisor name), and as value
677
    the hypervisor options. If not passed, the default hypervisor and
678
    hypervisor options will be inherited.
679

    
680
mac, ip, mode, link
681
    Specifications for the one NIC that will be created for the
682
    instance. 'bridge' is also accepted as a backwards compatibile
683
    key.
684

    
685
nics
686
    List of nics that will be created for the instance. Each entry
687
    should be a dict, with mac, ip, mode and link as possible keys.
688
    Please don't provide the "mac, ip, mode, link" parent keys if you
689
    use this method for specifying nics.
690

    
691
primary\_node, secondary\_node
692
    The primary and optionally the secondary node to use for the
693
    instance (in case an iallocator script is not used).
694

    
695
iallocator
696
    Instead of specifying the nodes, an iallocator script can be used
697
    to automatically compute them.
698

    
699
start
700
    whether to start the instance
701

    
702
ip\_check
703
    Skip the check for already-in-use instance; see the description in
704
    the **add** command for details.
705

    
706
name\_check
707
    Skip the name check for instances; see the description in the
708
    **add** command for details.
709

    
710
file\_storage\_dir, file\_driver
711
    Configuration for the file disk type, see the **add** command for
712
    details.
713

    
714

    
715
A simple definition for one instance can be (with most of the
716
parameters taken from the cluster defaults)::
717

    
718
    {
719
      "instance3": {
720
        "template": "drbd",
721
        "os": "debootstrap",
722
        "disk_size": ["25G"],
723
        "iallocator": "dumb"
724
      },
725
      "instance5": {
726
        "template": "drbd",
727
        "os": "debootstrap",
728
        "disk_size": ["25G"],
729
        "iallocator": "dumb",
730
        "hypervisor": "xen-hvm",
731
        "hvparams": {"acpi": true},
732
        "backend": {"maxmem": 512, "minmem": 256}
733
      }
734
    }
735

    
736
The command will display the job id for each submitted instance, as
737
follows::
738

    
739
    # gnt-instance batch-create instances.json
740
    instance3: 11224
741
    instance5: 11225
742

    
743
REMOVE
744
^^^^^^
745

    
746
**remove** [--ignore-failures] [--shutdown-timeout=*N*] [--submit]
747
[--force] {*instance*}
748

    
749
Remove an instance. This will remove all data from the instance and
750
there is *no way back*. If you are not sure if you use an instance
751
again, use **shutdown** first and leave it in the shutdown state for a
752
while.
753

    
754
The ``--ignore-failures`` option will cause the removal to proceed
755
even in the presence of errors during the removal of the instance
756
(e.g. during the shutdown or the disk removal). If this option is not
757
given, the command will stop at the first error.
758

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

    
764
The ``--submit`` option is used to send the job to the master daemon
765
but not wait for its completion. The job ID will be shown so that it
766
can be examined via **gnt-job info**.
767

    
768
The ``--force`` option is used to skip the interactive confirmation.
769

    
770
Example::
771

    
772
    # gnt-instance remove instance1.example.com
773

    
774

    
775
LIST
776
^^^^
777

    
778
| **list**
779
| [--no-headers] [--separator=*SEPARATOR*] [--units=*UNITS*] [-v]
780
| [{-o|--output} *[+]FIELD,...*] [--filter] [instance...]
781

    
782
Shows the currently configured instances with memory usage, disk
783
usage, the node they are running on, and their run status.
784

    
785
The ``--no-headers`` option will skip the initial header line. The
786
``--separator`` option takes an argument which denotes what will be
787
used between the output fields. Both these options are to help
788
scripting.
789

    
790
The units used to display the numeric values in the output varies,
791
depending on the options given. By default, the values will be
792
formatted in the most appropriate unit. If the ``--separator`` option
793
is given, then the values are shown in mebibytes to allow parsing by
794
scripts. In both cases, the ``--units`` option can be used to enforce
795
a given output unit.
796

    
797
The ``-v`` option activates verbose mode, which changes the display of
798
special field states (see **ganeti(7)**).
799

    
800
The ``-o (--output)`` option takes a comma-separated list of output
801
fields. The available fields and their meaning are:
802

    
803
@QUERY_FIELDS_INSTANCE@
804

    
805
If the value of the option starts with the character ``+``, the new
806
field(s) will be added to the default list. This allows one to quickly
807
see the default list plus a few other fields, instead of retyping the
808
entire list of fields.
809

    
810
There is a subtle grouping about the available output fields: all
811
fields except for ``oper_state``, ``oper_ram``, ``oper_vcpus`` and
812
``status`` are configuration value and not run-time values. So if you
813
don't select any of the these fields, the query will be satisfied
814
instantly from the cluster configuration, without having to ask the
815
remote nodes for the data. This can be helpful for big clusters when
816
you only want some data and it makes sense to specify a reduced set of
817
output fields.
818

    
819
If exactly one argument is given and it appears to be a query filter
820
(see **ganeti(7)**), the query result is filtered accordingly. For
821
ambiguous cases (e.g. a single field name as a filter) the ``--filter``
822
(``-F``) option forces the argument to be treated as a filter (e.g.
823
``gnt-instance list -F admin_state``).
824

    
825
The default output field list is: ``name``, ``os``, ``pnode``,
826
``admin_state``, ``oper_state``, ``oper_ram``.
827

    
828

    
829
LIST-FIELDS
830
~~~~~~~~~~~
831

    
832
**list-fields** [field...]
833

    
834
Lists available fields for instances.
835

    
836

    
837
INFO
838
^^^^
839

    
840
**info** [-s \| --static] [--roman] {--all \| *instance*}
841

    
842
Show detailed information about the given instance(s). This is
843
different from **list** as it shows detailed data about the instance's
844
disks (especially useful for the drbd disk template).
845

    
846
If the option ``-s`` is used, only information available in the
847
configuration file is returned, without querying nodes, making the
848
operation faster.
849

    
850
Use the ``--all`` to get info about all instances, rather than
851
explicitly passing the ones you're interested in.
852

    
853
The ``--roman`` option can be used to cause envy among people who like
854
ancient cultures, but are stuck with non-latin-friendly cluster
855
virtualization technologies.
856

    
857
MODIFY
858
^^^^^^
859

    
860
| **modify**
861
| [{-H|--hypervisor-parameters} *HYPERVISOR\_PARAMETERS*]
862
| [{-B|--backend-parameters} *BACKEND\_PARAMETERS*]
863
| [{-m|--runtime-memory} *SIZE*]
864
| [--net add*[:options]* \| --net remove \| --net *N:options*]
865
| [--disk add:size=*SIZE*[,vg=*VG*][,metavg=*VG*] \| --disk remove \|
866
|  --disk *N*:mode=*MODE*]
867
| [{-t|--disk-template} plain | {-t|--disk-template} drbd -n *new_secondary*] [--no-wait-for-sync]
868
| [--os-type=*OS* [--force-variant]]
869
| [{-O|--os-parameters} *param*=*value*... ]
870
| [--offline \| --online]
871
| [--submit]
872
| [--ignore-ipolicy]
873
| {*instance*}
874

    
875
Modifies the memory size, number of vcpus, ip address, MAC address
876
and/or nic parameters for an instance. It can also add and remove
877
disks and NICs to/from the instance. Note that you need to give at
878
least one of the arguments, otherwise the command complains.
879

    
880
The ``-H (--hypervisor-parameters)``, ``-B (--backend-parameters)``
881
and ``-O (--os-parameters)`` options specifies hypervisor, backend and
882
OS parameter options in the form of name=value[,...]. For details
883
which options can be specified, see the **add** command.
884

    
885
The ``-t (--disk-template)`` option will change the disk template of
886
the instance.  Currently only conversions between the plain and drbd
887
disk templates are supported, and the instance must be stopped before
888
attempting the conversion. When changing from the plain to the drbd
889
disk template, a new secondary node must be specified via the ``-n``
890
option. The option ``--no-wait-for-sync`` can be used when converting
891
to the ``drbd`` template in order to make the instance available for
892
startup before DRBD has finished resyncing.
893

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

    
898
The ``--disk add:size=``*SIZE* option adds a disk to the instance. The
899
optional ``vg=``*VG* option specifies LVM volume group other than
900
default vg to create the disk on. For DRBD disks, the ``metavg=``*VG*
901
option specifies the volume group for the metadata device. The
902
``--disk remove`` option will remove the last disk of the
903
instance. The ``--disk`` *N*``:mode=``*MODE* option will change the
904
mode of the Nth disk of the instance between read-only (``ro``) and
905
read-write (``rw``).
906

    
907
The ``--net add:``*options* option will add a new NIC to the
908
instance. The available options are the same as in the **add** command
909
(mac, ip, link, mode). The ``--net remove`` will remove the last NIC
910
of the instance, while the ``--net`` *N*:*options* option will change
911
the parameters of the Nth instance NIC.
912

    
913
The option ``-o (--os-type)`` will change the OS name for the instance
914
(without reinstallation). In case an OS variant is specified that is
915
not found, then by default the modification is refused, unless
916
``--force-variant`` is passed. An invalid OS will also be refused,
917
unless the ``--force`` option is given.
918

    
919
The ``--online`` and ``--offline`` options are used to transition an
920
instance into and out of the ``offline`` state. An instance can be
921
turned offline only if it was previously down. The ``--online`` option
922
fails if the instance was not in the ``offline`` state, otherwise it
923
changes instance's state to ``down``. These modifications take effect
924
immediately.
925

    
926
The ``--submit`` option is used to send the job to the master daemon
927
but not wait for its completion. The job ID will be shown so that it
928
can be examined via **gnt-job info**.
929

    
930
If ``--ignore-ipolicy`` is given any instance policy violations occuring
931
during this operation are ignored.
932

    
933
Most of the changes take effect at the next restart. If the instance is
934
running, there is no effect on the instance.
935

    
936
REINSTALL
937
^^^^^^^^^
938

    
939
| **reinstall** [{-o|--os-type} *os-type*] [--select-os] [-f *force*]
940
| [--force-multiple]
941
| [--instance \| --node \| --primary \| --secondary \| --all]
942
| [{-O|--os-parameters} *OS\_PARAMETERS*] [--submit] {*instance*...}
943

    
944
Reinstalls the operating system on the given instance(s). The
945
instance(s) must be stopped when running this command. If the ``-o
946
(--os-type)`` is specified, the operating system is changed.
947

    
948
The ``--select-os`` option switches to an interactive OS reinstall.
949
The user is prompted to select the OS template from the list of
950
available OS templates. OS parameters can be overridden using ``-O
951
(--os-parameters)`` (more documentation for this option under the
952
**add** command).
953

    
954
Since this is a potentially dangerous command, the user will be
955
required to confirm this action, unless the ``-f`` flag is passed.
956
When multiple instances are selected (either by passing multiple
957
arguments or by using the ``--node``, ``--primary``, ``--secondary``
958
or ``--all`` options), the user must pass the ``--force-multiple``
959
options to skip the interactive confirmation.
960

    
961
The ``--submit`` option is used to send the job to the master daemon
962
but not wait for its completion. The job ID will be shown so that it
963
can be examined via **gnt-job info**.
964

    
965
RENAME
966
^^^^^^
967

    
968
| **rename** [--no-ip-check] [--no-name-check] [--submit]
969
| {*instance*} {*new\_name*}
970

    
971
Renames the given instance. The instance must be stopped when running
972
this command. The requirements for the new name are the same as for
973
adding an instance: the new name must be resolvable and the IP it
974
resolves to must not be reachable (in order to prevent duplicate IPs
975
the next time the instance is started). The IP test can be skipped if
976
the ``--no-ip-check`` option is passed.
977

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

    
984
The ``--submit`` option is used to send the job to the master daemon
985
but not wait for its completion. The job ID will be shown so that it
986
can be examined via **gnt-job info**.
987

    
988
Starting/stopping/connecting to console
989
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
990

    
991
STARTUP
992
^^^^^^^
993

    
994
| **startup**
995
| [--force] [--ignore-offline]
996
| [--force-multiple] [--no-remember]
997
| [--instance \| --node \| --primary \| --secondary \| --all \|
998
| --tags \| --node-tags \| --pri-node-tags \| --sec-node-tags]
999
| [{-H|--hypervisor-parameters} ``key=value...``]
1000
| [{-B|--backend-parameters} ``key=value...``]
1001
| [--submit] [--paused]
1002
| {*name*...}
1003

    
1004
Starts one or more instances, depending on the following options.  The
1005
four available modes are:
1006

    
1007
--instance
1008
    will start the instances given as arguments (at least one argument
1009
    required); this is the default selection
1010

    
1011
--node
1012
    will start the instances who have the given node as either primary
1013
    or secondary
1014

    
1015
--primary
1016
    will start all instances whose primary node is in the list of nodes
1017
    passed as arguments (at least one node required)
1018

    
1019
--secondary
1020
    will start all instances whose secondary node is in the list of
1021
    nodes passed as arguments (at least one node required)
1022

    
1023
--all
1024
    will start all instances in the cluster (no arguments accepted)
1025

    
1026
--tags
1027
    will start all instances in the cluster with the tags given as
1028
    arguments
1029

    
1030
--node-tags
1031
    will start all instances in the cluster on nodes with the tags
1032
    given as arguments
1033

    
1034
--pri-node-tags
1035
    will start all instances in the cluster on primary nodes with the
1036
    tags given as arguments
1037

    
1038
--sec-node-tags
1039
    will start all instances in the cluster on secondary nodes with the
1040
    tags given as arguments
1041

    
1042
Note that although you can pass more than one selection option, the
1043
last one wins, so in order to guarantee the desired result, don't pass
1044
more than one such option.
1045

    
1046
Use ``--force`` to start even if secondary disks are failing.
1047
``--ignore-offline`` can be used to ignore offline primary nodes and
1048
mark the instance as started even if the primary is not available.
1049

    
1050
The ``--force-multiple`` will skip the interactive confirmation in the
1051
case the more than one instance will be affected.
1052

    
1053
The ``--no-remember`` option will perform the startup but not change
1054
the state of the instance in the configuration file (if it was stopped
1055
before, Ganeti will still thinks it needs to be stopped). This can be
1056
used for testing, or for a one shot-start where you don't want the
1057
watcher to restart the instance if it crashes.
1058

    
1059
The ``-H (--hypervisor-parameters)`` and ``-B (--backend-parameters)``
1060
options specify temporary hypervisor and backend parameters that can
1061
be used to start an instance with modified parameters. They can be
1062
useful for quick testing without having to modify an instance back and
1063
forth, e.g.::
1064

    
1065
    # gnt-instance start -H kernel_args="single" instance1
1066
    # gnt-instance start -B maxmem=2048 instance2
1067

    
1068

    
1069
The first form will start the instance instance1 in single-user mode,
1070
and the instance instance2 with 2GB of RAM (this time only, unless
1071
that is the actual instance memory size already). Note that the values
1072
override the instance parameters (and not extend them): an instance
1073
with "kernel\_args=ro" when started with -H kernel\_args=single will
1074
result in "single", not "ro single".  The ``--submit`` option is used
1075
to send the job to the master daemon but not wait for its
1076
completion. The job ID will be shown so that it can be examined via
1077
**gnt-job info**.
1078

    
1079
The ``--paused`` option is only valid for Xen and kvm hypervisors.  This
1080
pauses the instance at the start of bootup, awaiting ``gnt-instance
1081
console`` to unpause it, allowing the entire boot process to be
1082
monitored for debugging.
1083

    
1084
Example::
1085

    
1086
    # gnt-instance start instance1.example.com
1087
    # gnt-instance start --node node1.example.com node2.example.com
1088
    # gnt-instance start --all
1089

    
1090

    
1091
SHUTDOWN
1092
^^^^^^^^
1093

    
1094
| **shutdown**
1095
| [--timeout=*N*]
1096
| [--force-multiple] [--ignore-offline] [--no-remember]
1097
| [--instance \| --node \| --primary \| --secondary \| --all \|
1098
| --tags \| --node-tags \| --pri-node-tags \| --sec-node-tags]
1099
| [--submit]
1100
| {*name*...}
1101

    
1102
Stops one or more instances. If the instance cannot be cleanly stopped
1103
during a hardcoded interval (currently 2 minutes), it will forcibly
1104
stop the instance (equivalent to switching off the power on a physical
1105
machine).
1106

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

    
1112
The ``--instance``, ``--node``, ``--primary``, ``--secondary``,
1113
``--all``, ``--tags``, ``--node-tags``, ``--pri-node-tags`` and
1114
``--sec-node-tags`` options are similar as for the **startup** command
1115
and they influence the actual instances being shutdown.
1116

    
1117
The ``--submit`` option is used to send the job to the master daemon
1118
but not wait for its completion. The job ID will be shown so that it
1119
can be examined via **gnt-job info**.
1120

    
1121
``--ignore-offline`` can be used to ignore offline primary nodes and
1122
force the instance to be marked as stopped. This option should be used
1123
with care as it can lead to an inconsistent cluster state.
1124

    
1125
The ``--no-remember`` option will perform the shutdown but not change
1126
the state of the instance in the configuration file (if it was running
1127
before, Ganeti will still thinks it needs to be running). This can be
1128
useful for a cluster-wide shutdown, where some instances are marked as
1129
up and some as down, and you don't want to change the running state:
1130
you just need to disable the watcher, shutdown all instances with
1131
``--no-remember``, and when the watcher is activated again it will
1132
restore the correct runtime state for all instances.
1133

    
1134
Example::
1135

    
1136
    # gnt-instance shutdown instance1.example.com
1137
    # gnt-instance shutdown --all
1138

    
1139

    
1140
REBOOT
1141
^^^^^^
1142

    
1143
| **reboot**
1144
| [{-t|--type} *REBOOT-TYPE*]
1145
| [--ignore-secondaries]
1146
| [--shutdown-timeout=*N*]
1147
| [--force-multiple]
1148
| [--instance \| --node \| --primary \| --secondary \| --all \|
1149
| --tags \| --node-tags \| --pri-node-tags \| --sec-node-tags]
1150
| [--submit]
1151
| [*name*...]
1152

    
1153
Reboots one or more instances. The type of reboot depends on the value
1154
of ``-t (--type)``. A soft reboot does a hypervisor reboot, a hard reboot
1155
does a instance stop, recreates the hypervisor config for the instance
1156
and starts the instance. A full reboot does the equivalent of
1157
**gnt-instance shutdown && gnt-instance startup**.  The default is
1158
hard reboot.
1159

    
1160
For the hard reboot the option ``--ignore-secondaries`` ignores errors
1161
for the secondary node while re-assembling the instance disks.
1162

    
1163
The ``--instance``, ``--node``, ``--primary``, ``--secondary``,
1164
``--all``, ``--tags``, ``--node-tags``, ``--pri-node-tags`` and
1165
``--sec-node-tags`` options are similar as for the **startup** command
1166
and they influence the actual instances being rebooted.
1167

    
1168
The ``--shutdown-timeout`` is used to specify how much time to wait
1169
before forcing the shutdown (xm destroy in xen, killing the kvm
1170
process, for kvm). By default two minutes are given to each instance
1171
to stop.
1172

    
1173
The ``--force-multiple`` will skip the interactive confirmation in the
1174
case the more than one instance will be affected.
1175

    
1176
Example::
1177

    
1178
    # gnt-instance reboot instance1.example.com
1179
    # gnt-instance reboot --type=full instance1.example.com
1180

    
1181

    
1182
CONSOLE
1183
^^^^^^^
1184

    
1185
**console** [--show-cmd] {*instance*}
1186

    
1187
Connects to the console of the given instance. If the instance is not
1188
up, an error is returned. Use the ``--show-cmd`` option to display the
1189
command instead of executing it.
1190

    
1191
For HVM instances, this will attempt to connect to the serial console
1192
of the instance. To connect to the virtualized "physical" console of a
1193
HVM instance, use a VNC client with the connection info from the
1194
**info** command.
1195

    
1196
For Xen/kvm instances, if the instance is paused, this attempts to
1197
unpause the instance after waiting a few seconds for the connection to
1198
the console to be made.
1199

    
1200
Example::
1201

    
1202
    # gnt-instance console instance1.example.com
1203

    
1204

    
1205
Disk management
1206
~~~~~~~~~~~~~~~
1207

    
1208
REPLACE-DISKS
1209
^^^^^^^^^^^^^
1210

    
1211
**replace-disks** [--submit] [--early-release] [--ignore-ipolicy] {-p}
1212
[--disks *idx*] {*instance*}
1213

    
1214
**replace-disks** [--submit] [--early-release] [--ignore-ipolicy] {-s}
1215
[--disks *idx*] {*instance*}
1216

    
1217
**replace-disks** [--submit] [--early-release] [--ignore-ipolicy]
1218
{--iallocator *name* \| -- {*instance*}
1219

    
1220
**replace-disks** [--submit] [--early-release] [--ignore-ipolicy]
1221
{--auto} {*instance*}
1222

    
1223
This command is a generalized form for replacing disks. It is
1224
currently only valid for the mirrored (DRBD) disk template.
1225

    
1226
The first form (when passing the ``-p`` option) will replace the disks
1227
on the primary, while the second form (when passing the ``-s`` option
1228
will replace the disks on the secondary node. For these two cases (as
1229
the node doesn't change), it is possible to only run the replace for a
1230
subset of the disks, using the option ``--disks`` which takes a list
1231
of comma-delimited disk indices (zero-based), e.g. 0,2 to replace only
1232
the first and third disks.
1233

    
1234
The third form (when passing either the ``--iallocator`` or the
1235
``--new-secondary`` option) is designed to change secondary node of
1236
the instance. Specifying ``--iallocator`` makes the new secondary be
1237
selected automatically by the specified allocator plugin, otherwise
1238
the new secondary node will be the one chosen manually via the
1239
``--new-secondary`` option.
1240

    
1241
The fourth form (when using ``--auto``) will automatically determine
1242
which disks of an instance are faulty and replace them within the same
1243
node. The ``--auto`` option works only when an instance has only
1244
faulty disks on either the primary or secondary node; it doesn't work
1245
when both sides have faulty disks.
1246

    
1247
The ``--submit`` option is used to send the job to the master daemon
1248
but not wait for its completion. The job ID will be shown so that it
1249
can be examined via **gnt-job info**.
1250

    
1251
The ``--early-release`` changes the code so that the old storage on
1252
secondary node(s) is removed early (before the resync is completed)
1253
and the internal Ganeti locks for the current (and new, if any)
1254
secondary node are also released, thus allowing more parallelism in
1255
the cluster operation. This should be used only when recovering from a
1256
disk failure on the current secondary (thus the old storage is already
1257
broken) or when the storage on the primary node is known to be fine
1258
(thus we won't need the old storage for potential recovery).
1259

    
1260
The ``--ignore-ipolicy`` let the command ignore instance policy
1261
violations if replace-disks changes groups and the instance would
1262
violate the new groups instance policy.
1263

    
1264
Note that it is not possible to select an offline or drained node as a
1265
new secondary.
1266

    
1267
ACTIVATE-DISKS
1268
^^^^^^^^^^^^^^
1269

    
1270
**activate-disks** [--submit] [--ignore-size] {*instance*}
1271

    
1272
Activates the block devices of the given instance. If successful, the
1273
command will show the location and name of the block devices::
1274

    
1275
    node1.example.com:disk/0:/dev/drbd0
1276
    node1.example.com:disk/1:/dev/drbd1
1277

    
1278

    
1279
In this example, *node1.example.com* is the name of the node on which
1280
the devices have been activated. The *disk/0* and *disk/1* are the
1281
Ganeti-names of the instance disks; how they are visible inside the
1282
instance is hypervisor-specific. */dev/drbd0* and */dev/drbd1* are the
1283
actual block devices as visible on the node.  The ``--submit`` option
1284
is used to send the job to the master daemon but not wait for its
1285
completion. The job ID will be shown so that it can be examined via
1286
**gnt-job info**.
1287

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

    
1295
Note that it is safe to run this command while the instance is already
1296
running.
1297

    
1298
DEACTIVATE-DISKS
1299
^^^^^^^^^^^^^^^^
1300

    
1301
**deactivate-disks** [-f] [--submit] {*instance*}
1302

    
1303
De-activates the block devices of the given instance. Note that if you
1304
run this command for an instance with a drbd disk template, while it
1305
is running, it will not be able to shutdown the block devices on the
1306
primary node, but it will shutdown the block devices on the secondary
1307
nodes, thus breaking the replication.
1308

    
1309
The ``-f``/``--force`` option will skip checks that the instance is
1310
down; in case the hypervisor is confused and we can't talk to it,
1311
normally Ganeti will refuse to deactivate the disks, but with this
1312
option passed it will skip this check and directly try to deactivate
1313
the disks. This can still fail due to the instance actually running or
1314
other issues.
1315

    
1316
The ``--submit`` option is used to send the job to the master daemon
1317
but not wait for its completion. The job ID will be shown so that it
1318
can be examined via **gnt-job info**.
1319

    
1320
GROW-DISK
1321
^^^^^^^^^
1322

    
1323
**grow-disk** [--no-wait-for-sync] [--submit] {*instance*} {*disk*}
1324
{*amount*}
1325

    
1326
Grows an instance's disk. This is only possible for instances having a
1327
plain, drbd or rbd disk template.
1328

    
1329
Note that this command only change the block device size; it will not
1330
grow the actual filesystems, partitions, etc. that live on that
1331
disk. Usually, you will need to:
1332

    
1333
#. use **gnt-instance grow-disk**
1334

    
1335
#. reboot the instance (later, at a convenient time)
1336

    
1337
#. use a filesystem resizer, such as ext2online(8) or
1338
   xfs\_growfs(8) to resize the filesystem, or use fdisk(8) to change
1339
   the partition table on the disk
1340

    
1341
The *disk* argument is the index of the instance disk to grow. The
1342
*amount* argument is given either as a number (and it represents the
1343
amount to increase the disk with in mebibytes) or can be given similar
1344
to the arguments in the create instance operation, with a suffix
1345
denoting the unit.
1346

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

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

    
1355
The ``--submit`` option is used to send the job to the master daemon
1356
but not wait for its completion. The job ID will be shown so that it
1357
can be examined via **gnt-job info**.
1358

    
1359
Example (increase the first disk for instance1 by 16GiB)::
1360

    
1361
    # gnt-instance grow-disk instance1.example.com 0 16g
1362

    
1363

    
1364
Also note that disk shrinking is not supported; use **gnt-backup
1365
export** and then **gnt-backup import** to reduce the disk size of an
1366
instance.
1367

    
1368
RECREATE-DISKS
1369
^^^^^^^^^^^^^^
1370

    
1371
| **recreate-disks** [--submit] [-n node1:[node2]]
1372
| [--disk=*N*[:[size=*VAL*][,mode=*ro\|rw*]]] {*instance*}
1373

    
1374
Recreates all or a subset of disks of the given instance.
1375

    
1376
Note that this functionality should only be used for missing disks; if
1377
any of the given disks already exists, the operation will fail.  While
1378
this is suboptimal, recreate-disks should hopefully not be needed in
1379
normal operation and as such the impact of this is low.
1380

    
1381
If only a subset should be recreated, any number of ``disk`` options can
1382
be specified. It expects a disk index and an optional list of disk
1383
parameters to change. Only ``size`` and ``mode`` can be changed while
1384
recreating disks. To recreate all disks while changing parameters on
1385
a subset only, a ``--disk`` option must be given for every disk of the
1386
instance.
1387

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

    
1397
The ``--submit`` option is used to send the job to the master daemon
1398
but not wait for its completion. The job ID will be shown so that it
1399
can be examined via **gnt-job info**.
1400

    
1401
Recovery
1402
~~~~~~~~
1403

    
1404
FAILOVER
1405
^^^^^^^^
1406

    
1407
| **failover** [-f] [--ignore-consistency] [--ignore-ipolicy]
1408
| [--shutdown-timeout=*N*]
1409
| [{-n|--target-node} *node* \| {-I|--iallocator} *name*]
1410
| [--submit]
1411
| {*instance*}
1412

    
1413
Failover will stop the instance (if running), change its primary node,
1414
and if it was originally running it will start it again (on the new
1415
primary). This only works for instances with drbd template (in which
1416
case you can only fail to the secondary node) and for externally
1417
mirrored templates (blockdev and rbd) (which can change to any other
1418
node).
1419

    
1420
If the instance's disk template is of type blockdev or rbd, then you
1421
can explicitly specify the target node (which can be any node) using
1422
the ``-n`` or ``--target-node`` option, or specify an iallocator plugin
1423
using the ``-I`` or ``--iallocator`` option. If you omit both, the default
1424
iallocator will be used to specify the target node.
1425

    
1426
Normally the failover will check the consistency of the disks before
1427
failing over the instance. If you are trying to migrate instances off
1428
a dead node, this will fail. Use the ``--ignore-consistency`` option
1429
for this purpose. Note that this option can be dangerous as errors in
1430
shutting down the instance will be ignored, resulting in possibly
1431
having the instance running on two machines in parallel (on
1432
disconnected DRBD drives).
1433

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

    
1439
The ``--submit`` option is used to send the job to the master daemon
1440
but not wait for its completion. The job ID will be shown so that it
1441
can be examined via **gnt-job info**.
1442

    
1443
If ``--ignore-ipolicy`` is given any instance policy violations occuring
1444
during this operation are ignored.
1445

    
1446
Example::
1447

    
1448
    # gnt-instance failover instance1.example.com
1449

    
1450

    
1451
MIGRATE
1452
^^^^^^^
1453

    
1454
**migrate** [-f] {--cleanup} {*instance*}
1455

    
1456
**migrate** [-f] [--allow-failover] [--non-live]
1457
[--migration-mode=live\|non-live] [--ignore-ipolicy]
1458
[--no-runtime-changes]
1459
[{-n|--target-node} *node* \| {-I|--iallocator} *name*] {*instance*}
1460

    
1461
Migrate will move the instance to its secondary node without shutdown.
1462
As with failover, it only works for instances having the drbd disk
1463
template or an externally mirrored disk template type such as blockdev
1464
or rbd.
1465

    
1466
If the instance's disk template is of type blockdev or rbd, then you can
1467
explicitly specify the target node (which can be any node) using the
1468
``-n`` or ``--target-node`` option, or specify an iallocator plugin
1469
using the ``-I`` or ``--iallocator`` option. If you omit both, the
1470
default iallocator will be used to specify the target node.
1471

    
1472
The migration command needs a perfectly healthy instance, as we rely
1473
on the dual-master capability of drbd8 and the disks of the instance
1474
are not allowed to be degraded.
1475

    
1476
The ``--non-live`` and ``--migration-mode=non-live`` options will
1477
switch (for the hypervisors that support it) between a "fully live"
1478
(i.e. the interruption is as minimal as possible) migration and one in
1479
which the instance is frozen, its state saved and transported to the
1480
remote node, and then resumed there. This all depends on the
1481
hypervisor support for two different methods. In any case, it is not
1482
an error to pass this parameter (it will just be ignored if the
1483
hypervisor doesn't support it). The option ``--migration-mode=live``
1484
option will request a fully-live migration. The default, when neither
1485
option is passed, depends on the hypervisor parameters (and can be
1486
viewed with the **gnt-cluster info** command).
1487

    
1488
If the ``--cleanup`` option is passed, the operation changes from
1489
migration to attempting recovery from a failed previous migration.  In
1490
this mode, Ganeti checks if the instance runs on the correct node (and
1491
updates its configuration if not) and ensures the instances's disks
1492
are configured correctly. In this mode, the ``--non-live`` option is
1493
ignored.
1494

    
1495
The option ``-f`` will skip the prompting for confirmation.
1496

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

    
1502
If ``--ignore-ipolicy`` is given any instance policy violations occuring
1503
during this operation are ignored.
1504

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

    
1509
Example (and expected output)::
1510

    
1511
    # gnt-instance migrate instance1
1512
    Instance instance1 will be migrated. Note that migration
1513
    might impact the instance if anything goes wrong (e.g. due to bugs in
1514
    the hypervisor). Continue?
1515
    y/[n]/?: y
1516
    Migrating instance instance1.example.com
1517
    * checking disk consistency between source and target
1518
    * switching node node2.example.com to secondary mode
1519
    * changing into standalone mode
1520
    * changing disks into dual-master mode
1521
    * wait until resync is done
1522
    * preparing node2.example.com to accept the instance
1523
    * migrating instance to node2.example.com
1524
    * switching node node1.example.com to secondary mode
1525
    * wait until resync is done
1526
    * changing into standalone mode
1527
    * changing disks into single-master mode
1528
    * wait until resync is done
1529
    * done
1530
    #
1531

    
1532

    
1533
MOVE
1534
^^^^
1535

    
1536
**move** [-f] [--ignore-consistency]
1537
[-n *node*] [--shutdown-timeout=*N*] [--submit] [--ignore-ipolicy]
1538
{*instance*}
1539

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

    
1543
Note that since this operation is done via data copy, it will take a
1544
long time for big disks (similar to replace-disks for a drbd
1545
instance).
1546

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

    
1552
The ``--ignore-consistency`` option will make Ganeti ignore any errors
1553
in trying to shutdown the instance on its node; useful if the
1554
hypervisor is broken and you want to recuperate the data.
1555

    
1556
The ``--submit`` option is used to send the job to the master daemon
1557
but not wait for its completion. The job ID will be shown so that it
1558
can be examined via **gnt-job info**.
1559

    
1560
If ``--ignore-ipolicy`` is given any instance policy violations occuring
1561
during this operation are ignored.
1562

    
1563
Example::
1564

    
1565
    # gnt-instance move -n node3.example.com instance1.example.com
1566

    
1567

    
1568
CHANGE-GROUP
1569
~~~~~~~~~~~~
1570

    
1571
**change-group** [--iallocator *NAME*] [--to *GROUP*...] {*instance*}
1572

    
1573
This command moves an instance to another node group. The move is
1574
calculated by an iallocator, either given on the command line or as a
1575
cluster default.
1576

    
1577
If no specific destination groups are specified using ``--to``, all
1578
groups except the one containing the instance are considered.
1579

    
1580
Example::
1581

    
1582
    # gnt-instance change-group -I hail --to rack2 inst1.example.com
1583

    
1584

    
1585
TAGS
1586
~~~~
1587

    
1588
ADD-TAGS
1589
^^^^^^^^
1590

    
1591
**add-tags** [--from *file*] {*instancename*} {*tag*...}
1592

    
1593
Add tags to the given instance. If any of the tags contains invalid
1594
characters, the entire operation will abort.
1595

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

    
1602
LIST-TAGS
1603
^^^^^^^^^
1604

    
1605
**list-tags** {*instancename*}
1606

    
1607
List the tags of the given instance.
1608

    
1609
REMOVE-TAGS
1610
^^^^^^^^^^^
1611

    
1612
**remove-tags** [--from *file*] {*instancename*} {*tag*...}
1613

    
1614
Remove tags from the given instance. If any of the tags are not
1615
existing on the node, the entire operation will abort.
1616

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

    
1623
.. vim: set textwidth=72 :
1624
.. Local Variables:
1625
.. mode: rst
1626
.. fill-column: 72
1627
.. End: