gnt-instance 47.4 KB
Newer Older
Iustin Pop's avatar
Iustin Pop committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
#!/usr/bin/python
#

# Copyright (C) 2006, 2007 Google Inc.
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful, but
# WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
# General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
# 02110-1301, USA.


22
23
24
25
# pylint: disable-msg=W0401,W0614
# W0401: Wildcard import ganeti.cli
# W0614: Unused import %s from wildcard import (since we need cli)

Iustin Pop's avatar
Iustin Pop committed
26
27
import sys
import os
28
import itertools
29
import simplejson
Iustin Pop's avatar
Iustin Pop committed
30
31
32
33
from optparse import make_option
from cStringIO import StringIO

from ganeti.cli import *
34
from ganeti import cli
Iustin Pop's avatar
Iustin Pop committed
35
36
37
from ganeti import opcodes
from ganeti import constants
from ganeti import utils
38
39
40
41
42
43
44
45
46
from ganeti import errors


_SHUTDOWN_CLUSTER = "cluster"
_SHUTDOWN_NODES_BOTH = "nodes"
_SHUTDOWN_NODES_PRI = "nodes-pri"
_SHUTDOWN_NODES_SEC = "nodes-sec"
_SHUTDOWN_INSTANCES = "instances"

47

48
49
_VALUE_TRUE = "true"

50
#: default list of options for L{ListInstances}
51
_LIST_DEF_FIELDS = [
52
  "name", "hypervisor", "os", "pnode", "status", "oper_ram",
53
54
  ]

55

56
57
58
59
60
def _ExpandMultiNames(mode, names):
  """Expand the given names using the passed mode.

  For _SHUTDOWN_CLUSTER, all instances will be returned. For
  _SHUTDOWN_NODES_PRI/SEC, all instances having those nodes as
61
  primary/secondary will be returned. For _SHUTDOWN_NODES_BOTH, all
62
63
64
65
  instances having those nodes as either primary or secondary will be
  returned. For _SHUTDOWN_INSTANCES, the given instances will be
  returned.

66
67
68
69
70
71
72
73
74
75
76
77
  @param mode: one of L{_SHUTDOWN_CLUSTER}, L{_SHUTDOWN_NODES_BOTH},
      L{_SHUTDOWN_NODES_PRI}, L{_SHUTDOWN_NODES_SEC} or
      L{_SHUTDOWN_INSTANCES}
  @param names: a list of names; for cluster, it must be empty,
      and for node and instance it must be a list of valid item
      names (short names are valid as usual, e.g. node1 instead of
      node1.example.com)
  @rtype: list
  @return: the list of names after the expansion
  @raise errors.ProgrammerError: for unknown selection type
  @raise errors.OpPrereqError: for invalid input parameters

78
79
80
81
  """
  if mode == _SHUTDOWN_CLUSTER:
    if names:
      raise errors.OpPrereqError("Cluster filter mode takes no arguments")
82
83
    client = GetClient()
    idata = client.QueryInstances([], ["name"])
84
85
86
87
88
89
90
    inames = [row[0] for row in idata]

  elif mode in (_SHUTDOWN_NODES_BOTH,
                _SHUTDOWN_NODES_PRI,
                _SHUTDOWN_NODES_SEC):
    if not names:
      raise errors.OpPrereqError("No node names passed")
91
92
    client = GetClient()
    ndata = client.QueryNodes(names, ["name", "pinst_list", "sinst_list"])
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
    ipri = [row[1] for row in ndata]
    pri_names = list(itertools.chain(*ipri))
    isec = [row[2] for row in ndata]
    sec_names = list(itertools.chain(*isec))
    if mode == _SHUTDOWN_NODES_BOTH:
      inames = pri_names + sec_names
    elif mode == _SHUTDOWN_NODES_PRI:
      inames = pri_names
    elif mode == _SHUTDOWN_NODES_SEC:
      inames = sec_names
    else:
      raise errors.ProgrammerError("Unhandled shutdown type")

  elif mode == _SHUTDOWN_INSTANCES:
    if not names:
      raise errors.OpPrereqError("No instance names passed")
109
110
    client = GetClient()
    idata = client.QueryInstances(names, ["name"])
111
112
113
114
115
116
    inames = [row[0] for row in idata]

  else:
    raise errors.OpPrereqError("Unknown mode '%s'" % mode)

  return inames
Iustin Pop's avatar
Iustin Pop committed
117
118


119
120
121
122
123
124
def _ConfirmOperation(inames, text):
  """Ask the user to confirm an operation on a list of instances.

  This function is used to request confirmation for doing an operation
  on a given list of instances.

125
126
127
128
129
130
131
132
  @type inames: list
  @param inames: the list of names that we display when
      we ask for confirmation
  @type text: str
  @param text: the operation that the user should confirm
      (e.g. I{shutdown} or I{startup})
  @rtype: boolean
  @return: True or False depending on user's confirmation.
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152

  """
  count = len(inames)
  msg = ("The %s will operate on %d instances.\n"
         "Do you want to continue?" % (text, count))
  affected = ("\nAffected instances:\n" +
              "\n".join(["  %s" % name for name in inames]))

  choices = [('y', True, 'Yes, execute the %s' % text),
             ('n', False, 'No, abort the %s' % text)]

  if count > 20:
    choices.insert(1, ('v', 'v', 'View the list of affected instances'))
    ask = msg
  else:
    ask = msg + affected

  choice = AskUser(ask, choices)
  if choice == 'v':
    choices.pop(1)
153
    choice = AskUser(msg + affected, choices)
154
155
156
  return choice


157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
def _TransformPath(user_input):
  """Transform a user path into a canonical value.

  This function transforms the a path passed as textual information
  into the constants that the LU code expects.

  """
  if user_input:
    if user_input.lower() == "default":
      result_path = constants.VALUE_DEFAULT
    elif user_input.lower() == "none":
      result_path = constants.VALUE_NONE
    else:
      if not os.path.isabs(user_input):
        raise errors.OpPrereqError("Path '%s' is not an absolute filename" %
                                   user_input)
      result_path = user_input
  else:
    result_path = constants.VALUE_DEFAULT

  return result_path


Iustin Pop's avatar
Iustin Pop committed
180
def ListInstances(opts, args):
Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
181
  """List instances and their properties.
Iustin Pop's avatar
Iustin Pop committed
182

183
184
185
186
187
188
  @param opts: the command line options selected by the user
  @type args: list
  @param args: should be an empty list
  @rtype: int
  @return: the desired exit code

Iustin Pop's avatar
Iustin Pop committed
189
190
  """
  if opts.output is None:
191
192
193
    selected_fields = _LIST_DEF_FIELDS
  elif opts.output.startswith("+"):
    selected_fields = _LIST_DEF_FIELDS + opts.output[1:].split(",")
Iustin Pop's avatar
Iustin Pop committed
194
195
196
  else:
    selected_fields = opts.output.split(",")

197
  output = GetClient().QueryInstances([], selected_fields)
Iustin Pop's avatar
Iustin Pop committed
198
199

  if not opts.no_headers:
200
201
202
    headers = {
      "name": "Instance", "os": "OS", "pnode": "Primary_node",
      "snodes": "Secondary_Nodes", "admin_state": "Autostart",
Iustin Pop's avatar
Iustin Pop committed
203
      "oper_state": "Running",
204
      "oper_ram": "Memory", "disk_template": "Disk_template",
205
      "ip": "IP_address", "mac": "MAC_address",
Iustin Pop's avatar
Iustin Pop committed
206
      "bridge": "Bridge",
207
      "sda_size": "Disk/0", "sdb_size": "Disk/1",
208
      "status": "Status", "tags": "Tags",
209
      "network_port": "Network_port",
210
211
212
213
214
215
216
217
      "hv/kernel_path": "Kernel_path",
      "hv/initrd_path": "Initrd_path",
      "hv/boot_order": "HVM_boot_order",
      "hv/acpi": "HVM_ACPI",
      "hv/pae": "HVM_PAE",
      "hv/cdrom_image_path": "HVM_CDROM_image_path",
      "hv/nic_type": "HVM_NIC_type",
      "hv/disk_type": "HVM_Disk_type",
218
      "hv/vnc_bind_address": "VNC_bind_address",
219
      "serial_no": "SerialNo", "hypervisor": "Hypervisor",
220
      "hvparams": "Hypervisor_parameters",
Iustin Pop's avatar
Iustin Pop committed
221
222
      "be/memory": "Configured_memory",
      "be/vcpus": "VCPUs",
223
      "be/auto_balance": "Auto_balance",
Iustin Pop's avatar
Iustin Pop committed
224
225
226
      "disk.count": "Disks", "disk.sizes": "Disk_sizes",
      "nic.count": "NICs", "nic.ips": "NIC_IPs",
      "nic.bridges": "NIC_bridges", "nic.macs": "NIC_MACs",
227
      }
228
229
230
  else:
    headers = None

231
  unitfields = ["be/memory", "oper_ram", "sd(a|b)_size", "disk\.size/.*"]
232
  numfields = ["be/memory", "oper_ram", "sd(a|b)_size", "be/vcpus",
Iustin Pop's avatar
Iustin Pop committed
233
               "serial_no", "(disk|nic)\.count", "disk\.size/.*"]
234

Iustin Pop's avatar
Iustin Pop committed
235
236
  list_type_fields = ("tags", "disk.sizes",
                      "nic.macs", "nic.ips", "nic.bridges")
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
  # change raw values to nicer strings
  for row in output:
    for idx, field in enumerate(selected_fields):
      val = row[idx]
      if field == "snodes":
        val = ",".join(val) or "-"
      elif field == "admin_state":
        if val:
          val = "yes"
        else:
          val = "no"
      elif field == "oper_state":
        if val is None:
          val = "(node down)"
        elif val: # True
          val = "running"
        else:
          val = "stopped"
      elif field == "oper_ram":
        if val is None:
          val = "(node down)"
      elif field == "sda_size" or field == "sdb_size":
        if val is None:
          val = "N/A"
261
      elif field in list_type_fields:
Iustin Pop's avatar
Iustin Pop committed
262
        val = ",".join(str(item) for item in val)
263
264
      elif val is None:
        val = "-"
265
266
      row[idx] = str(val)

267
268
  data = GenerateTable(separator=opts.separator, headers=headers,
                       fields=selected_fields, unitfields=unitfields,
269
                       numfields=numfields, data=output, units=opts.units)
270
271

  for line in data:
272
    ToStdout(line)
Iustin Pop's avatar
Iustin Pop committed
273
274
275
276
277
278
279

  return 0


def AddInstance(opts, args):
  """Add an instance to the cluster.

280
281
282
283
284
  @param opts: the command line options selected by the user
  @type args: list
  @param args: should contain only one element, the new instance name
  @rtype: int
  @return: the desired exit code
Iustin Pop's avatar
Iustin Pop committed
285
286
287
288

  """
  instance = args[0]

289
290
  (pnode, snode) = SplitNodeOption(opts.node)

291
292
293
294
  hypervisor = None
  hvparams = {}
  if opts.hypervisor:
    hypervisor, hvparams = opts.hypervisor
295

296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
  if opts.nics:
    try:
      nic_max = max(int(nidx[0])+1 for nidx in opts.nics)
    except ValueError, err:
      raise errors.OpPrereqError("Invalid NIC index passed: %s" % str(err))
    nics = [{}] * nic_max
    for nidx, ndict in opts.nics.items():
      nidx = int(nidx)
      nics[nidx] = ndict
  else:
    # default of one nic, all auto
    nics = [{}]

  if not opts.disks and opts.disk_template != constants.DT_DISKLESS:
    raise errors.OpPrereqError("No disk information specified")
  elif opts.disks and opts.disk_template == constants.DT_DISKLESS:
    raise errors.OpPrereqError("Diskless instance but disk information passeD")
  else:
    try:
      disk_max = max(int(didx[0])+1 for didx in opts.disks)
    except ValueError, err:
      raise errors.OpPrereqError("Invalid disk index passed: %s" % str(err))
    disks = [{}] * disk_max
    for didx, ddict in opts.disks:
      didx = int(didx)
      if "size" not in ddict:
        raise errors.OpPrereqError("Missing size for disk %d" % didx)
      try:
        ddict["size"] = utils.ParseUnit(ddict["size"])
      except ValueError, err:
        raise errors.OpPrereqError("Invalid disk size for disk %d: %s" %
                                   (didx, err))
      disks[didx] = ddict

330
  ValidateBeParams(opts.beparams)
Iustin Pop's avatar
Iustin Pop committed
331

332
333
##  kernel_path = _TransformPath(opts.kernel_path)
##  initrd_path = _TransformPath(opts.initrd_path)
334

335
336
337
338
339
340
341
342
##  hvm_acpi = opts.hvm_acpi == _VALUE_TRUE
##  hvm_pae = opts.hvm_pae == _VALUE_TRUE

##  if ((opts.hvm_cdrom_image_path is not None) and
##      (opts.hvm_cdrom_image_path.lower() == constants.VALUE_NONE)):
##    hvm_cdrom_image_path = None
##  else:
##    hvm_cdrom_image_path = opts.hvm_cdrom_image_path
343

Iustin Pop's avatar
Iustin Pop committed
344
  op = opcodes.OpCreateInstance(instance_name=instance,
345
                                disks=disks,
Iustin Pop's avatar
Iustin Pop committed
346
                                disk_template=opts.disk_template,
347
                                nics=nics,
Iustin Pop's avatar
Iustin Pop committed
348
                                mode=constants.INSTANCE_CREATE,
349
                                os_type=opts.os, pnode=pnode,
Iustin Pop's avatar
Iustin Pop committed
350
                                snode=snode,
351
                                start=opts.start, ip_check=opts.ip_check,
352
                                wait_for_sync=opts.wait_for_sync,
353
354
                                hypervisor=hypervisor,
                                hvparams=hvparams,
Iustin Pop's avatar
Iustin Pop committed
355
                                beparams=opts.beparams,
356
                                iallocator=opts.iallocator,
357
358
                                file_storage_dir=opts.file_storage_dir,
                                file_driver=opts.file_driver,
359
                                )
360

361
  SubmitOrSend(op, opts)
Iustin Pop's avatar
Iustin Pop committed
362
363
364
  return 0


365
def BatchCreate(opts, args):
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
  """Create instances using a definition file.

  This function reads a json file with instances defined
  in the form::

    {"instance-name":{
      "disk_size": 25,
      "swap_size": 1024,
      "template": "drbd",
      "backend": {
        "memory": 512,
        "vcpus": 1 },
      "os": "etch-image",
      "primary_node": "firstnode",
      "secondary_node": "secondnode",
      "iallocator": "dumb"}
    }

  Note that I{primary_node} and I{secondary_node} have precedence over
  I{iallocator}.

  @param opts: the command line options selected by the user
  @type args: list
  @param args: should contain one element, the json filename
  @rtype: int
  @return: the desired exit code
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410

  """
  _DEFAULT_SPECS = {"disk_size": 20 * 1024,
                    "swap_size": 4 * 1024,
                    "backend": {},
                    "iallocator": None,
                    "primary_node": None,
                    "secondary_node": None,
                    "ip": 'none',
                    "mac": 'auto',
                    "bridge": None,
                    "start": True,
                    "ip_check": True,
                    "hypervisor": None,
                    "file_storage_dir": None,
                    "file_driver": 'loop'}

  def _PopulateWithDefaults(spec):
    """Returns a new hash combined with default values."""
411
412
413
    mydict = _DEFAULT_SPECS.copy()
    mydict.update(spec)
    return mydict
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474

  def _Validate(spec):
    """Validate the instance specs."""
    # Validate fields required under any circumstances
    for required_field in ('os', 'template'):
      if required_field not in spec:
        raise errors.OpPrereqError('Required field "%s" is missing.' %
                                   required_field)
    # Validate special fields
    if spec['primary_node'] is not None:
      if (spec['template'] in constants.DTS_NET_MIRROR and
          spec['secondary_node'] is None):
        raise errors.OpPrereqError('Template requires secondary node, but'
                                   ' there was no secondary provided.')
    elif spec['iallocator'] is None:
      raise errors.OpPrereqError('You have to provide at least a primary_node'
                                 ' or an iallocator.')

    if (spec['hypervisor'] and
        not isinstance(spec['hypervisor'], dict)):
      raise errors.OpPrereqError('Hypervisor parameters must be a dict.')

  json_filename = args[0]
  fd = open(json_filename, 'r')
  try:
    instance_data = simplejson.load(fd)
  finally:
    fd.close()

  # Iterate over the instances and do:
  #  * Populate the specs with default value
  #  * Validate the instance specs
  for (name, specs) in instance_data.iteritems():
    specs = _PopulateWithDefaults(specs)
    _Validate(specs)

    hypervisor = None
    hvparams = {}
    if specs['hypervisor']:
      hypervisor, hvparams = specs['hypervisor'].iteritems()

    op = opcodes.OpCreateInstance(instance_name=name,
                                  disk_size=specs['disk_size'],
                                  swap_size=specs['swap_size'],
                                  disk_template=specs['template'],
                                  mode=constants.INSTANCE_CREATE,
                                  os_type=specs['os'],
                                  pnode=specs['primary_node'],
                                  snode=specs['secondary_node'],
                                  ip=specs['ip'], bridge=specs['bridge'],
                                  start=specs['start'],
                                  ip_check=specs['ip_check'],
                                  wait_for_sync=True,
                                  mac=specs['mac'],
                                  iallocator=specs['iallocator'],
                                  hypervisor=hypervisor,
                                  hvparams=hvparams,
                                  beparams=specs['backend'],
                                  file_storage_dir=specs['file_storage_dir'],
                                  file_driver=specs['file_driver'])

475
    ToStdout("%s: %s", name, cli.SendJob([op]))
476
477
478
479

  return 0


480
481
482
def ReinstallInstance(opts, args):
  """Reinstall an instance.

483
484
485
486
487
488
  @param opts: the command line options selected by the user
  @type args: list
  @param args: should contain only one element, the name of the
      instance to be reinstalled
  @rtype: int
  @return: the desired exit code
489
490
491
492

  """
  instance_name = args[0]

493
494
495
496
497
  if opts.select_os is True:
    op = opcodes.OpDiagnoseOS(output_fields=["name", "valid"], names=[])
    result = SubmitOpCode(op)

    if not result:
498
      ToStdout("Can't get the OS list")
499
500
      return 1

501
    ToStdout("Available OS templates:")
502
503
504
    number = 0
    choices = []
    for entry in result:
505
      ToStdout("%3s: %s", number, entry[0])
506
507
508
509
510
511
512
513
      choices.append(("%s" % number, entry[0], entry[0]))
      number = number + 1

    choices.append(('x', 'exit', 'Exit gnt-instance reinstall'))
    selected = AskUser("Enter OS template name or number (or x to abort):",
                       choices)

    if selected == 'exit':
514
      ToStdout("User aborted reinstall, exiting")
515
516
      return 1

517
    os_name = selected
518
  else:
519
    os_name = opts.os
520

521
  if not opts.force:
522
523
    usertext = ("This will reinstall the instance %s and remove"
                " all data. Continue?") % instance_name
524
    if not AskUser(usertext):
525
526
      return 1

527
  op = opcodes.OpReinstallInstance(instance_name=instance_name,
528
                                   os_type=os_name)
529
  SubmitOrSend(op, opts)
530
531
532
533

  return 0


Iustin Pop's avatar
Iustin Pop committed
534
535
536
def RemoveInstance(opts, args):
  """Remove an instance.

537
538
539
540
541
542
  @param opts: the command line options selected by the user
  @type args: list
  @param args: should contain only one element, the name of
      the instance to be removed
  @rtype: int
  @return: the desired exit code
Iustin Pop's avatar
Iustin Pop committed
543
544
545
546
547
548
549
550
551

  """
  instance_name = args[0]
  force = opts.force

  if not force:
    usertext = ("This will remove the volumes of the instance %s"
                " (including mirrors), thus removing all the data"
                " of the instance. Continue?") % instance_name
552
    if not AskUser(usertext):
Iustin Pop's avatar
Iustin Pop committed
553
554
      return 1

Iustin Pop's avatar
Iustin Pop committed
555
556
  op = opcodes.OpRemoveInstance(instance_name=instance_name,
                                ignore_failures=opts.ignore_failures)
557
  SubmitOrSend(op, opts)
Iustin Pop's avatar
Iustin Pop committed
558
559
560
  return 0


561
def RenameInstance(opts, args):
Guido Trotter's avatar
Guido Trotter committed
562
  """Rename an instance.
563

564
565
566
567
568
569
  @param opts: the command line options selected by the user
  @type args: list
  @param args: should contain two elements, the old and the
      new instance names
  @rtype: int
  @return: the desired exit code
570
571
572
573
574

  """
  op = opcodes.OpRenameInstance(instance_name=args[0],
                                new_name=args[1],
                                ignore_ip=opts.ignore_ip)
575
  SubmitOrSend(op, opts)
576
577
578
  return 0


Iustin Pop's avatar
Iustin Pop committed
579
580
581
582
def ActivateDisks(opts, args):
  """Activate an instance's disks.

  This serves two purposes:
583
584
    - it allows (as long as the instance is not running)
      mounting the disks and modifying them from the node
Iustin Pop's avatar
Iustin Pop committed
585
586
    - it repairs inactive secondary drbds

587
588
589
590
591
592
  @param opts: the command line options selected by the user
  @type args: list
  @param args: should contain only one element, the instance name
  @rtype: int
  @return: the desired exit code

Iustin Pop's avatar
Iustin Pop committed
593
594
595
  """
  instance_name = args[0]
  op = opcodes.OpActivateInstanceDisks(instance_name=instance_name)
596
  disks_info = SubmitOrSend(op, opts)
Iustin Pop's avatar
Iustin Pop committed
597
  for host, iname, nname in disks_info:
598
    ToStdout("%s:%s:%s", host, iname, nname)
Iustin Pop's avatar
Iustin Pop committed
599
600
601
602
  return 0


def DeactivateDisks(opts, args):
603
  """Deactivate an instance's disks..
Iustin Pop's avatar
Iustin Pop committed
604
605
606
607

  This function takes the instance name, looks for its primary node
  and the tries to shutdown its block devices on that node.

608
609
610
611
612
613
  @param opts: the command line options selected by the user
  @type args: list
  @param args: should contain only one element, the instance name
  @rtype: int
  @return: the desired exit code

Iustin Pop's avatar
Iustin Pop committed
614
615
616
  """
  instance_name = args[0]
  op = opcodes.OpDeactivateInstanceDisks(instance_name=instance_name)
617
  SubmitOrSend(op, opts)
Iustin Pop's avatar
Iustin Pop committed
618
619
620
  return 0


Iustin Pop's avatar
Iustin Pop committed
621
def GrowDisk(opts, args):
622
  """Grow an instance's disks.
Iustin Pop's avatar
Iustin Pop committed
623

624
625
626
627
628
629
  @param opts: the command line options selected by the user
  @type args: list
  @param args: should contain two elements, the instance name
      whose disks we grow and the disk name, e.g. I{sda}
  @rtype: int
  @return: the desired exit code
Iustin Pop's avatar
Iustin Pop committed
630
631
632
633

  """
  instance = args[0]
  disk = args[1]
634
635
636
637
  try:
    disk = int(disk)
  except ValueError, err:
    raise errors.OpPrereqError("Invalid disk index: %s" % str(err))
Iustin Pop's avatar
Iustin Pop committed
638
  amount = utils.ParseUnit(args[2])
639
640
  op = opcodes.OpGrowDisk(instance_name=instance, disk=disk, amount=amount,
                          wait_for_sync=opts.wait_for_sync)
641
  SubmitOrSend(op, opts)
Iustin Pop's avatar
Iustin Pop committed
642
643
644
  return 0


Iustin Pop's avatar
Iustin Pop committed
645
def StartupInstance(opts, args):
646
  """Startup instances.
Iustin Pop's avatar
Iustin Pop committed
647

648
649
650
651
652
653
654
655
656
657
  Depending on the options given, this will start one or more
  instances.

  @param opts: the command line options selected by the user
  @type args: list
  @param args: the instance or node names based on which we
      create the final selection (in conjunction with the
      opts argument)
  @rtype: int
  @return: the desired exit code
Iustin Pop's avatar
Iustin Pop committed
658
659

  """
660
661
662
  if opts.multi_mode is None:
    opts.multi_mode = _SHUTDOWN_INSTANCES
  inames = _ExpandMultiNames(opts.multi_mode, args)
663
664
  if not inames:
    raise errors.OpPrereqError("Selection filter does not match any instances")
665
666
667
668
  multi_on = opts.multi_mode != _SHUTDOWN_INSTANCES or len(inames) > 1
  if not (opts.force_multi or not multi_on
          or _ConfirmOperation(inames, "startup")):
    return 1
669
670
671
672
673
  for name in inames:
    op = opcodes.OpStartupInstance(instance_name=name,
                                   force=opts.force,
                                   extra_args=opts.extra_args)
    if multi_on:
674
      ToStdout("Starting up %s", name)
675
676
677
678
    try:
      SubmitOrSend(op, opts)
    except JobSubmittedException, err:
      _, txt = FormatError(err)
679
      ToStdout("%s", txt)
Iustin Pop's avatar
Iustin Pop committed
680
681
  return 0

682

683
def RebootInstance(opts, args):
684
685
686
687
  """Reboot instance(s).

  Depending on the parameters given, this will reboot one or more
  instances.
688

689
690
691
692
693
694
695
  @param opts: the command line options selected by the user
  @type args: list
  @param args: the instance or node names based on which we
      create the final selection (in conjunction with the
      opts argument)
  @rtype: int
  @return: the desired exit code
696
697
698
699
700

  """
  if opts.multi_mode is None:
    opts.multi_mode = _SHUTDOWN_INSTANCES
  inames = _ExpandMultiNames(opts.multi_mode, args)
701
702
  if not inames:
    raise errors.OpPrereqError("Selection filter does not match any instances")
703
704
705
706
707
708
709
710
711
  multi_on = opts.multi_mode != _SHUTDOWN_INSTANCES or len(inames) > 1
  if not (opts.force_multi or not multi_on
          or _ConfirmOperation(inames, "reboot")):
    return 1
  for name in inames:
    op = opcodes.OpRebootInstance(instance_name=name,
                                  reboot_type=opts.reboot_type,
                                  ignore_secondaries=opts.ignore_secondaries)

712
    SubmitOrSend(op, opts)
713
  return 0
Iustin Pop's avatar
Iustin Pop committed
714

715

Iustin Pop's avatar
Iustin Pop committed
716
717
718
def ShutdownInstance(opts, args):
  """Shutdown an instance.

719
720
721
722
723
724
725
  @param opts: the command line options selected by the user
  @type args: list
  @param args: the instance or node names based on which we
      create the final selection (in conjunction with the
      opts argument)
  @rtype: int
  @return: the desired exit code
Iustin Pop's avatar
Iustin Pop committed
726
727

  """
728
729
730
  if opts.multi_mode is None:
    opts.multi_mode = _SHUTDOWN_INSTANCES
  inames = _ExpandMultiNames(opts.multi_mode, args)
731
732
  if not inames:
    raise errors.OpPrereqError("Selection filter does not match any instances")
733
734
735
736
  multi_on = opts.multi_mode != _SHUTDOWN_INSTANCES or len(inames) > 1
  if not (opts.force_multi or not multi_on
          or _ConfirmOperation(inames, "shutdown")):
    return 1
737
738
739
  for name in inames:
    op = opcodes.OpShutdownInstance(instance_name=name)
    if multi_on:
740
      ToStdout("Shutting down %s", name)
741
742
743
744
    try:
      SubmitOrSend(op, opts)
    except JobSubmittedException, err:
      _, txt = FormatError(err)
745
      ToStdout("%s", txt)
Iustin Pop's avatar
Iustin Pop committed
746
747
748
749
750
751
  return 0


def ReplaceDisks(opts, args):
  """Replace the disks of an instance

752
753
754
755
756
  @param opts: the command line options selected by the user
  @type args: list
  @param args: should contain only one element, the instance name
  @rtype: int
  @return: the desired exit code
Iustin Pop's avatar
Iustin Pop committed
757
758
759

  """
  instance_name = args[0]
760
  new_2ndary = opts.new_secondary
761
  iallocator = opts.iallocator
762
  if opts.disks is None:
763
    disks = []
764
  else:
765
766
767
768
    try:
      disks = [int(i) for i in opts.disks.split(",")]
    except ValueError, err:
      raise errors.OpPrereqError("Invalid disk index passed: %s" % str(err))
769
770
771
772
  if opts.on_primary == opts.on_secondary: # no -p or -s passed, or both passed
    mode = constants.REPLACE_DISK_ALL
  elif opts.on_primary: # only on primary:
    mode = constants.REPLACE_DISK_PRI
773
    if new_2ndary is not None or iallocator is not None:
774
775
      raise errors.OpPrereqError("Can't change secondary node on primary disk"
                                 " replacement")
776
777
  elif opts.on_secondary is not None or iallocator is not None:
    # only on secondary
778
779
780
    mode = constants.REPLACE_DISK_SEC

  op = opcodes.OpReplaceDisks(instance_name=args[0], disks=disks,
781
782
                              remote_node=new_2ndary, mode=mode,
                              iallocator=iallocator)
783
  SubmitOrSend(op, opts)
Iustin Pop's avatar
Iustin Pop committed
784
785
786
787
788
789
790
791
792
  return 0


def FailoverInstance(opts, args):
  """Failover an instance.

  The failover is done by shutting it down on its present node and
  starting it on the secondary.

793
794
795
796
797
  @param opts: the command line options selected by the user
  @type args: list
  @param args: should contain only one element, the instance name
  @rtype: int
  @return: the desired exit code
Iustin Pop's avatar
Iustin Pop committed
798
799

  """
800
801
  instance_name = args[0]
  force = opts.force
Iustin Pop's avatar
Iustin Pop committed
802

803
804
805
806
807
808
  if not force:
    usertext = ("Failover will happen to image %s."
                " This requires a shutdown of the instance. Continue?" %
                (instance_name,))
    if not AskUser(usertext):
      return 1
Iustin Pop's avatar
Iustin Pop committed
809

810
811
  op = opcodes.OpFailoverInstance(instance_name=instance_name,
                                  ignore_consistency=opts.ignore_consistency)
812
  SubmitOrSend(op, opts)
813
  return 0
Iustin Pop's avatar
Iustin Pop committed
814
815
816
817
818


def ConnectToInstanceConsole(opts, args):
  """Connect to the console of an instance.

819
820
821
822
823
  @param opts: the command line options selected by the user
  @type args: list
  @param args: should contain only one element, the instance name
  @rtype: int
  @return: the desired exit code
Iustin Pop's avatar
Iustin Pop committed
824
825
826
827
828

  """
  instance_name = args[0]

  op = opcodes.OpConnectConsole(instance_name=instance_name)
829
  cmd = SubmitOpCode(op)
830
831

  if opts.show_command:
832
    ToStdout("%s", utils.ShellQuoteArgs(cmd))
833
834
835
836
  else:
    try:
      os.execvp(cmd[0], cmd)
    finally:
837
      ToStderr("Can't run console command %s with arguments:\n'%s'",
838
               cmd[0], " ".join(cmd))
839
      os._exit(1)
Iustin Pop's avatar
Iustin Pop committed
840
841


842
def _FormatBlockDevInfo(buf, dev, indent_level, static):
Iustin Pop's avatar
Iustin Pop committed
843
844
  """Show block device information.

845
  This is only used by L{ShowInstanceConfig}, but it's too big to be
Iustin Pop's avatar
Iustin Pop committed
846
847
  left for an inline definition.

848
849
850
851
852
853
854
855
856
857
858
  @type buf: StringIO
  @param buf: buffer that will accumulate the output
  @type dev: dict
  @param dev: dictionary with disk information
  @type indent_level: int
  @param indent_level: the indendation level we are at, used for
      the layout of the device tree
  @type static: boolean
  @param static: wheter the device information doesn't contain
      runtime information but only static data

Iustin Pop's avatar
Iustin Pop committed
859
860
  """
  def helper(buf, dtype, status):
861
862
863
864
865
866
867
868
869
870
    """Format one line for physical device status.

    @type buf: StringIO
    @param buf: buffer that will accumulate the output
    @type dtype: str
    @param dtype: a constant from the L{constants.LDS_BLOCK} set
    @type status: tuple
    @param status: a tuple as returned from L{backend.FindBlockDevice}

    """
Iustin Pop's avatar
Iustin Pop committed
871
872
873
    if not status:
      buf.write("not active\n")
    else:
874
      (path, major, minor, syncp, estt, degr, ldisk) = status
875
876
877
878
879
880
881
882
883
884
885
      if major is None:
        major_string = "N/A"
      else:
        major_string = str(major)

      if minor is None:
        minor_string = "N/A"
      else:
        minor_string = str(minor)

      buf.write("%s (%s:%s)" % (path, major_string, minor_string))
886
      if dtype in (constants.LD_DRBD8, ):
Iustin Pop's avatar
Iustin Pop committed
887
888
889
890
891
892
893
894
895
896
897
898
        if syncp is not None:
          sync_text = "*RECOVERING* %5.2f%%," % syncp
          if estt:
            sync_text += " ETA %ds" % estt
          else:
            sync_text += " ETA unknown"
        else:
          sync_text = "in sync"
        if degr:
          degr_text = "*DEGRADED*"
        else:
          degr_text = "ok"
899
900
901
902
903
        if ldisk:
          ldisk_text = " *MISSING DISK*"
        else:
          ldisk_text = ""
        buf.write(" %s, status %s%s" % (sync_text, degr_text, ldisk_text))
904
      elif dtype == constants.LD_LV:
905
906
        if ldisk:
          ldisk_text = " *FAILED* (failed drive?)"
907
        else:
908
909
          ldisk_text = ""
        buf.write(ldisk_text)
Iustin Pop's avatar
Iustin Pop committed
910
911
912
913
914
915
      buf.write("\n")

  if dev["iv_name"] is not None:
    data = "  - %s, " % dev["iv_name"]
  else:
    data = "  - "
916
  data += "access mode: %s, " % dev["mode"]
Iustin Pop's avatar
Iustin Pop committed
917
918
919
920
921
922
  data += "type: %s" % dev["dev_type"]
  if dev["logical_id"] is not None:
    data += ", logical_id: %s" % (dev["logical_id"],)
  elif dev["physical_id"] is not None:
    data += ", physical_id: %s" % (dev["physical_id"],)
  buf.write("%*s%s\n" % (2*indent_level, "", data))
923
924
925
  if not static:
    buf.write("%*s    primary:   " % (2*indent_level, ""))
    helper(buf, dev["dev_type"], dev["pstatus"])
Iustin Pop's avatar
Iustin Pop committed
926

927
  if dev["sstatus"] and not static:
Iustin Pop's avatar
Iustin Pop committed
928
929
930
931
932
    buf.write("%*s    secondary: " % (2*indent_level, ""))
    helper(buf, dev["dev_type"], dev["sstatus"])

  if dev["children"]:
    for child in dev["children"]:
933
      _FormatBlockDevInfo(buf, child, indent_level+1, static)
Iustin Pop's avatar
Iustin Pop committed
934
935
936
937
938


def ShowInstanceConfig(opts, args):
  """Compute instance run-time status.

939
940
941
942
943
944
945
  @param opts: the command line options selected by the user
  @type args: list
  @param args: either an empty list, and then we query all
      instances, or should contain a list of instance names
  @rtype: int
  @return: the desired exit code

Iustin Pop's avatar
Iustin Pop committed
946
947
  """
  retcode = 0
948
  op = opcodes.OpQueryInstanceData(instances=args, static=opts.static)
Iustin Pop's avatar
Iustin Pop committed
949
950
  result = SubmitOpCode(op)
  if not result:
951
    ToStdout("No instances.")
Iustin Pop's avatar
Iustin Pop committed
952
953
954
955
956
957
958
    return 1

  buf = StringIO()
  retcode = 0
  for instance_name in result:
    instance = result[instance_name]
    buf.write("Instance name: %s\n" % instance["name"])
959
960
961
962
963
964
    buf.write("State: configured to be %s" % instance["config_state"])
    if not opts.static:
      buf.write(", actual state is %s" % instance["run_state"])
    buf.write("\n")
    ##buf.write("Considered for memory checks in cluster verify: %s\n" %
    ##          instance["auto_balance"])
Iustin Pop's avatar
Iustin Pop committed
965
966
967
968
    buf.write("  Nodes:\n")
    buf.write("    - primary: %s\n" % instance["pnode"])
    buf.write("    - secondaries: %s\n" % ", ".join(instance["snodes"]))
    buf.write("  Operating system: %s\n" % instance["os"])
969
970
    if instance.has_key("network_port"):
      buf.write("  Allocated network port: %s\n" % instance["network_port"])
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
    buf.write("  Hypervisor: %s\n" % instance["hypervisor"])
    if instance["hypervisor"] == constants.HT_XEN_PVM:
      hvattrs = ((constants.HV_KERNEL_PATH, "kernel path"),
                 (constants.HV_INITRD_PATH, "initrd path"))
    elif instance["hypervisor"] == constants.HT_XEN_HVM:
      hvattrs = ((constants.HV_BOOT_ORDER, "boot order"),
                 (constants.HV_ACPI, "ACPI"),
                 (constants.HV_PAE, "PAE"),
                 (constants.HV_CDROM_IMAGE_PATH, "virtual CDROM"),
                 (constants.HV_NIC_TYPE, "NIC type"),
                 (constants.HV_DISK_TYPE, "Disk type"),
                 (constants.HV_VNC_BIND_ADDRESS, "VNC bind address"),
                 )
      # custom console information for HVM
      vnc_bind_address = instance["hv_actual"][constants.HV_VNC_BIND_ADDRESS]
      if vnc_bind_address == constants.BIND_ADDRESS_GLOBAL:
        vnc_console_port = "%s:%s" % (instance["pnode"],
                                      instance["network_port"])
      elif vnc_bind_address == constants.LOCALHOST_IP_ADDRESS:
        vnc_console_port = "%s:%s on node %s" % (vnc_bind_address,
                                                 instance["network_port"],
                                                 instance["pnode"])
993
      else:
994
995
996
997
998
999
1000
1001
1002
1003
1004
        vnc_console_port = "%s:%s" % (vnc_bind_address,
                                      instance["network_port"])
      buf.write("    - console connection: vnc to %s\n" % vnc_console_port)

    else:
      # auto-handle other hypervisor types
      hvattrs = [(key, key) for key in instance["hv_actual"]]

    for key, desc in hvattrs:
      if key in instance["hv_instance"]:
        val = instance["hv_instance"][key]
1005
      else:
1006
1007
        val = "default (%s)" % instance["hv_actual"][key]
      buf.write("    - %s: %s\n" % (desc, val))
Iustin Pop's avatar
Iustin Pop committed
1008
    buf.write("  Hardware:\n")
Iustin Pop's avatar
Iustin Pop committed
1009
1010
1011
1012
    buf.write("    - VCPUs: %d\n" %
              instance["be_actual"][constants.BE_VCPUS])
    buf.write("    - memory: %dMiB\n" %
              instance["be_actual"][constants.BE_MEMORY])
1013
1014
1015
1016
    buf.write("    - NICs:\n")
    for idx, (mac, ip, bridge) in enumerate(instance["nics"]):
      buf.write("      - nic/%d: MAC: %s, IP: %s, bridge: %s\n" %
                (idx, mac, ip, bridge))
Iustin Pop's avatar
Iustin Pop committed
1017
1018
1019
    buf.write("  Block devices:\n")

    for device in instance["disks"]:
1020
      _FormatBlockDevInfo(buf, device, 1, opts.static)
Iustin Pop's avatar
Iustin Pop committed
1021

1022
  ToStdout(buf.getvalue().rstrip('\n'))
Iustin Pop's avatar
Iustin Pop committed
1023
1024
1025
  return retcode


1026
def SetInstanceParams(opts, args):
Iustin Pop's avatar
Iustin Pop committed
1027
1028
1029
1030
  """Modifies an instance.

  All parameters take effect only at the next restart of the instance.

1031
1032
1033
1034
1035
  @param opts: the command line options selected by the user
  @type args: list
  @param args: should contain only one element, the instance name
  @rtype: int
  @return: the desired exit code
Iustin Pop's avatar
Iustin Pop committed
1036
1037

  """
1038
1039
  if not (opts.ip or opts.bridge or opts.mac or
          opts.hypervisor or opts.beparams):
1040
    ToStderr("Please give at least one of the parameters.")
Iustin Pop's avatar
Iustin Pop committed
1041
1042
    return 1

1043
1044
1045
1046
  if constants.BE_MEMORY in opts.beparams:
    opts.beparams[constants.BE_MEMORY] = utils.ParseUnit(
      opts.beparams[constants.BE_MEMORY])

Iustin Pop's avatar
Iustin Pop committed
1047
1048
  op = opcodes.OpSetInstanceParams(instance_name=args[0],
                                   ip=opts.ip,
1049
                                   bridge=opts.bridge, mac=opts.mac,
1050
                                   hvparams=opts.hypervisor,
Iustin Pop's avatar
Iustin Pop committed
1051
                                   beparams=opts.beparams,
1052
                                   force=opts.force)
1053

1054
1055
  # even if here we process the result, we allow submit only
  result = SubmitOrSend(op, opts)
Iustin Pop's avatar
Iustin Pop committed
1056
1057

  if result:
1058
    ToStdout("Modified instance %s", args[0])
Iustin Pop's avatar
Iustin Pop committed
1059
    for param, data in result:
1060
1061
1062
      ToStdout(" - %-5s -> %s", param, data)
    ToStdout("Please don't forget that these parameters take effect"
             " only at the next start of the instance.")
Iustin Pop's avatar
Iustin Pop committed
1063
1064
1065
1066
1067
1068
1069
  return 0


# options used in more than one cmd
node_opt = make_option("-n", "--node", dest="node", help="Target node",
                       metavar="<node>")

1070
os_opt = cli_option("-o", "--os-type", dest="os", help="What OS to run",
Michael Hanselmann's avatar
Michael Hanselmann committed
1071
                    metavar="<os>")
1072

1073
# multi-instance selection options
1074
1075
1076
1077
1078
m_force_multi = make_option("--force-multiple", dest="force_multi",
                            help="Do not ask for confirmation when more than"
                            " one instance is affected",
                            action="store_true", default=False)

1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
m_pri_node_opt = make_option("--primary", dest="multi_mode",
                             help="Filter by nodes (primary only)",
                             const=_SHUTDOWN_NODES_PRI, action="store_const")

m_sec_node_opt = make_option("--secondary", dest="multi_mode",
                             help="Filter by nodes (secondary only)",
                             const=_SHUTDOWN_NODES_SEC, action="store_const")

m_node_opt = make_option("--node", dest="multi_mode",
                         help="Filter by nodes (primary and secondary)",
                         const=_SHUTDOWN_NODES_BOTH, action="store_const")

m_clust_opt = make_option("--all", dest="multi_mode",
                          help="Select all instances in the cluster",
                          const=_SHUTDOWN_CLUSTER, action="store_const")

m_inst_opt = make_option("--instance", dest="multi_mode",
                         help="Filter by instance name [default]",
                         const=_SHUTDOWN_INSTANCES, action="store_const")


Iustin Pop's avatar
Iustin Pop committed
1100
1101
1102
# this is defined separately due to readability only
add_opts = [
  DEBUG_OPT,
1103
1104
1105
  make_option("-n", "--node", dest="node",
              help="Target node and optional secondary node",
              metavar="<pnode>[:<snode>]"),
1106
1107
  cli_option("-s", "--os-size", dest="size", help="Disk size, in MiB unless"
             " a suffix is used",
Iustin Pop's avatar
Iustin Pop committed
1108
             default=20 * 1024, type="unit", metavar="<size>"),
1109
1110
  cli_option("--swap-size", dest="swap", help="Swap size, in MiB unless a"
             " suffix is used",
Iustin Pop's avatar
Iustin Pop committed
1111
             default=4 * 1024, type="unit", metavar="<size>"),
1112
  os_opt,
Iustin Pop's avatar
Iustin Pop committed
1113
1114
1115
  keyval_option("-B", "--backend", dest="beparams",
                type="keyval", default={},
                help="Backend parameters"),
Iustin Pop's avatar
Iustin Pop committed
1116
  make_option("-t", "--disk-template", dest="disk_template",
1117
              help="Custom disk setup (diskless, file, plain or drbd)",
1118
              default=None, metavar="TEMPL"),
1119
1120
1121
1122
1123
1124
1125
1126
  ikv_option("--disk", help="Disk information",
             default=[], dest="disks",
             action="append",
             type="identkeyval"),
  ikv_option("--net", help="NIC information",
             default=[], dest="nics",
             action="append",
             type="identkeyval"),
Iustin Pop's avatar
Iustin Pop committed
1127
1128
  make_option("--no-wait-for-sync", dest="wait_for_sync", default=True,
              action="store_false", help="Don't wait for sync (DANGEROUS!)"),
1129
1130
1131
1132
1133
1134
  make_option("--no-start", dest="start", default=True,
              action="store_false", help="Don't start the instance after"
              " creation"),
  make_option("--no-ip-check", dest="ip_check", default=True,
              action="store_false", help="Don't check that the instance's IP"
              " is alive (only valid with --no-start)"),
1135
1136
1137
1138
1139
  make_option("--file-storage-dir", dest="file_storage_dir",
              help="Relative path under default cluster-wide file storage dir"
              " to store file-based disks", default=None,
              metavar="<DIR>"),
  make_option("--file-driver", dest="file_driver", help="Driver to use"
1140
1141
1142
1143
              " for image files", default="loop", metavar="<DRIVER>"),
  make_option("--iallocator", metavar="<NAME>",
              help="Select nodes for the instance automatically using the"
              " <NAME> iallocator plugin", default=None, type="string"),
1144
1145
1146
1147
  ikv_option("-H", "--hypervisor", dest="hypervisor",
              help="Hypervisor and hypervisor options, in the format"
              " hypervisor:option=value,option=value,...", default=None,
              type="identkeyval"),
1148
  SUBMIT_OPT,
Iustin Pop's avatar
Iustin Pop committed
1149
1150
1151
1152
  ]

commands = {
  'add': (AddInstance, ARGS_ONE, add_opts,
1153
          "[...] -t disk-type -n node[:secondary-node] -o os-type <name>",
Iustin Pop's avatar
Iustin Pop committed
1154
          "Creates and adds a new instance to the cluster"),
1155
1156
1157
1158
  'batch-create': (BatchCreate, ARGS_ONE,
                   [DEBUG_OPT],
                   "<instances_file.json>",
                   "Create a bunch of instances based on specs in the file."),
1159
1160
1161
1162
1163
  'console': (ConnectToInstanceConsole, ARGS_ONE,
              [DEBUG_OPT,
               make_option("--show-cmd", dest="show_command",
                           action="store_true", default=False,
                           help=("Show command instead of executing it"))],
1164
              "[--show-cmd] <instance>",
Iustin Pop's avatar
Iustin Pop committed
1165
              "Opens a console on the specified instance"),
1166
  'failover': (FailoverInstance, ARGS_ONE,
1167
               [DEBUG_OPT, FORCE_OPT,
Iustin Pop's avatar
Iustin Pop committed
1168
1169
1170
1171
                make_option("--ignore-consistency", dest="ignore_consistency",
                            action="store_true", default=False,
                            help="Ignore the consistency of the disks on"
                            " the secondary"),
1172
                SUBMIT_OPT,
Iustin Pop's avatar
Iustin Pop committed
1173
                ],
1174
               "[-f] <instance>",
Iustin Pop's avatar
Iustin Pop committed
1175
               "Stops the instance and starts it on the backup node, using"
1176
               " the remote mirror (only for instances of type drbd)"),
1177
1178
1179
1180
1181
1182
1183
  'info': (ShowInstanceConfig, ARGS_ANY,
           [DEBUG_OPT,
            make_option("-s", "--static", dest="static",
                        action="store_true", default=False,
                        help="Only show configuration data, not runtime data"),
            ], "[-s] [<instance>...]",
           "Show information on the specified instance(s)"),
Iustin Pop's avatar
Iustin Pop committed
1184
  'list': (ListInstances, ARGS_NONE,
1185
           [DEBUG_OPT, NOHDR_OPT, SEP_OPT, USEUNITS_OPT, FIELDS_OPT], "",
1186
1187
           "Lists the instances and their status. The available fields are"
           " (see the man page for details): status, oper_state, oper_ram,"
1188
           " name, os, pnode, snodes, admin_state, admin_ram, disk_template,"
1189
1190
           " ip, mac, bridge, sda_size, sdb_size, vcpus, serial_no,"
           " hypervisor."
1191
           " The default field"
1192
1193
           " list is (in order): %s." % ", ".join(_LIST_DEF_FIELDS),
           ),
1194
1195
1196
1197
1198
  'reinstall': (ReinstallInstance, ARGS_ONE,
                [DEBUG_OPT, FORCE_OPT, os_opt,
                 make_option("--select-os", dest="select_os",
                             action="store_true", default=False,
                             help="Interactive OS reinstall, lists available"
1199
1200
1201
                             " OS templates for selection"),
                 SUBMIT_OPT,
                 ],
1202
                "[-f] <instance>", "Reinstall a stopped instance"),
Iustin Pop's avatar
Iustin Pop committed
1203
1204
1205
1206
1207
1208
1209
  'remove': (RemoveInstance, ARGS_ONE,
             [DEBUG_OPT, FORCE_OPT,
              make_option("--ignore-failures", dest="ignore_failures",
                          action="store_true", default=False,
                          help=("Remove the instance from the cluster even"
                                " if there are failures during the removal"
                                " process (shutdown, disk removal, etc.)")),
1210
              SUBMIT_OPT,
Iustin Pop's avatar
Iustin Pop committed
1211
              ],
1212
             "[-f] <instance>", "Shuts down the instance and removes it"),
1213
1214
1215
1216
1217
1218
  'rename': (RenameInstance, ARGS_FIXED(2),
             [DEBUG_OPT,
              make_option("--no-ip-check", dest="ignore_ip",
                          help="Do not check that the IP of the new name"
                          " is alive",
                          default=False, action="store_true"),
1219
              SUBMIT_OPT,
1220
              ],
1221
             "<instance> <new_name>", "Rename the instance"),
Iustin Pop's avatar
Iustin Pop committed
1222
1223
1224
  'replace-disks': (ReplaceDisks, ARGS_ONE,
                    [DEBUG_OPT,
                     make_option("-n", "--new-secondary", dest="new_secondary",
1225
1226
1227
1228
1229
                                 help=("New secondary node (for secondary"
                                       " node change)"), metavar="NODE"),
                     make_option("-p", "--on-primary", dest="on_primary",
                                 default=False, action="store_true",
                                 help=("Replace the disk(s) on the primary"
1230
                                       " node (only for the drbd template)")),
1231
1232
1233
                     make_option("-s", "--on-secondary", dest="on_secondary",
                                 default=False, action="store_true",
                                 help=("Replace the disk(s) on the secondary"
1234
                                       " node (only for the drbd template)")),
1235
1236