gnt-instance 41.3 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
22
23
#!/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.


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

from ganeti.cli import *
from ganeti import opcodes
from ganeti import logger
from ganeti import constants
from ganeti import utils
33
34
35
36
37
38
39
40
41
from ganeti import errors


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

42

43
44
_VALUE_TRUE = "true"

45
46
47
48
_LIST_DEF_FIELDS = [
  "name", "os", "pnode", "status", "oper_ram",
  ]

49

50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
def _ExpandMultiNames(mode, names):
  """Expand the given names using the passed mode.

  Args:
    - mode, which can be one of _SHUTDOWN_CLUSTER, _SHUTDOWN_NODES_BOTH,
      _SHUTDOWN_NODES_PRI, _SHUTDOWN_NODES_SEC or _SHUTDOWN_INSTANCES
    - names, which is 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)

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

  """
  if mode == _SHUTDOWN_CLUSTER:
    if names:
      raise errors.OpPrereqError("Cluster filter mode takes no arguments")
    op = opcodes.OpQueryInstances(output_fields=["name"], names=[])
    idata = SubmitOpCode(op)
    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")
    op = opcodes.OpQueryNodes(output_fields=["name", "pinst_list",
                                             "sinst_list"], names=names)
    ndata = SubmitOpCode(op)
    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")
    op = opcodes.OpQueryInstances(output_fields=["name"], names=names)
    idata = SubmitOpCode(op)
    inames = [row[0] for row in idata]

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

  return inames
Iustin Pop's avatar
Iustin Pop committed
108
109


110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
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.

  The inames argument is what the selection algorithm computed, and
  the text argument is the operation we should tell the user to
  confirm (e.g. 'shutdown' or 'startup').

  Returns: boolean depending on user's confirmation.

  """
  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)
141
    choice = AskUser(msg + affected, choices)
142
143
144
  return choice


145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
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
168
def ListInstances(opts, args):
Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
169
  """List instances and their properties.
Iustin Pop's avatar
Iustin Pop committed
170
171
172

  """
  if opts.output is None:
173
174
175
    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
176
177
178
  else:
    selected_fields = opts.output.split(",")

179
  output = GetClient().QueryInstances([], selected_fields)
Iustin Pop's avatar
Iustin Pop committed
180
181

  if not opts.no_headers:
182
183
184
185
186
187
188
189
    headers = {
      "name": "Instance", "os": "OS", "pnode": "Primary_node",
      "snodes": "Secondary_Nodes", "admin_state": "Autostart",
      "oper_state": "Running", "admin_ram": "Configured_memory",
      "oper_ram": "Memory", "disk_template": "Disk_template",
      "ip": "IP Address", "mac": "MAC Address",
      "bridge": "Bridge", "vcpus": "VCPUs",
      "sda_size": "Disk/0", "sdb_size": "Disk/1",
190
      "status": "Status", "tags": "Tags",
191
      }
192
193
194
195
  else:
    headers = None

  if opts.human_readable:
196
    unitfields = ["admin_ram", "oper_ram", "sda_size", "sdb_size"]
197
198
199
  else:
    unitfields = None

200
  numfields = ["admin_ram", "oper_ram", "sda_size", "sdb_size", "vcpus"]
201

202
  list_type_fields = ("tags",)
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
  # 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"
227
228
      elif field in list_type_fields:
        val = ",".join(val)
229
230
      row[idx] = str(val)

231
232
233
234
235
236
  data = GenerateTable(separator=opts.separator, headers=headers,
                       fields=selected_fields, unitfields=unitfields,
                       numfields=numfields, data=output)

  for line in data:
    logger.ToStdout(line)
Iustin Pop's avatar
Iustin Pop committed
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255

  return 0


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

  Args:
    opts - class with options as members
    args - list with a single element, the instance name
  Opts used:
    mem - amount of memory to allocate to instance (MiB)
    size - amount of disk space to allocate to instance (MiB)
    os - which OS to run on instance
    node - node to run new instance on

  """
  instance = args[0]

256
257
  (pnode, snode) = SplitNodeOption(opts.node)

258
259
260
  kernel_path = _TransformPath(opts.kernel_path)
  initrd_path = _TransformPath(opts.initrd_path)

261
262
263
264
265
266
267
268
269
  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

Iustin Pop's avatar
Iustin Pop committed
270
271
272
273
  op = opcodes.OpCreateInstance(instance_name=instance, mem_size=opts.mem,
                                disk_size=opts.size, swap_size=opts.swap,
                                disk_template=opts.disk_template,
                                mode=constants.INSTANCE_CREATE,
274
275
                                os_type=opts.os, pnode=pnode,
                                snode=snode, vcpus=opts.vcpus,
276
277
                                ip=opts.ip, bridge=opts.bridge,
                                start=opts.start, ip_check=opts.ip_check,
278
279
280
                                wait_for_sync=opts.wait_for_sync,
                                mac=opts.mac,
                                kernel_path=kernel_path,
281
                                initrd_path=initrd_path,
282
                                iallocator=opts.iallocator,
283
                                hvm_boot_order=opts.hvm_boot_order,
284
285
                                file_storage_dir=opts.file_storage_dir,
                                file_driver=opts.file_driver,
286
287
                                hvm_acpi=hvm_acpi, hvm_pae=hvm_pae,
                                hvm_cdrom_image_path=hvm_cdrom_image_path,
288
289
290
                                vnc_bind_address=opts.vnc_bind_address,
                                hvm_nic_type=opts.hvm_nic_type,
                                hvm_disk_type=opts.hvm_disk_type)
291

Iustin Pop's avatar
Iustin Pop committed
292
293
294
295
  SubmitOpCode(op)
  return 0


296
297
298
299
300
301
302
303
304
305
306
def ReinstallInstance(opts, args):
  """Reinstall an instance.

  Args:
    opts - class with options as members
    args - list containing a single element, the instance name

  """
  instance_name = args[0]

  if not opts.force:
307
308
    usertext = ("This will reinstall the instance %s and remove"
                " all data. Continue?") % instance_name
309
    if not AskUser(usertext):
310
311
      return 1

312
313
  op = opcodes.OpReinstallInstance(instance_name=instance_name,
                                   os_type=opts.os)
314
315
316
317
318
  SubmitOpCode(op)

  return 0


Iustin Pop's avatar
Iustin Pop committed
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
def RemoveInstance(opts, args):
  """Remove an instance.

  Args:
    opts - class with options as members
    args - list containing a single element, the instance name

  """
  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
334
    if not AskUser(usertext):
Iustin Pop's avatar
Iustin Pop committed
335
336
      return 1

Iustin Pop's avatar
Iustin Pop committed
337
338
  op = opcodes.OpRemoveInstance(instance_name=instance_name,
                                ignore_failures=opts.ignore_failures)
Iustin Pop's avatar
Iustin Pop committed
339
340
341
342
  SubmitOpCode(op)
  return 0


343
def RenameInstance(opts, args):
Guido Trotter's avatar
Guido Trotter committed
344
  """Rename an instance.
345
346
347
348
349
350
351
352
353
354
355
356
357
358

  Args:
    opts - class with options as members
    args - list containing two elements, the instance name and the new name

  """
  op = opcodes.OpRenameInstance(instance_name=args[0],
                                new_name=args[1],
                                ignore_ip=opts.ignore_ip)
  SubmitOpCode(op)

  return 0


Iustin Pop's avatar
Iustin Pop committed
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
def ActivateDisks(opts, args):
  """Activate an instance's disks.

  This serves two purposes:
    - it allows one (as long as the instance is not running) to mount
    the disks and modify them from the node
    - it repairs inactive secondary drbds

  """
  instance_name = args[0]
  op = opcodes.OpActivateInstanceDisks(instance_name=instance_name)
  disks_info = SubmitOpCode(op)
  for host, iname, nname in disks_info:
    print "%s:%s:%s" % (host, iname, nname)
  return 0


def DeactivateDisks(opts, args):
  """Command-line interface for _ShutdownInstanceBlockDevices.

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

  """
  instance_name = args[0]
  op = opcodes.OpDeactivateInstanceDisks(instance_name=instance_name)
  SubmitOpCode(op)
  return 0


Iustin Pop's avatar
Iustin Pop committed
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
def GrowDisk(opts, args):
  """Command-line interface for _ShutdownInstanceBlockDevices.

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

  """
  instance = args[0]
  disk = args[1]
  amount = utils.ParseUnit(args[2])
  op = opcodes.OpGrowDisk(instance_name=instance, disk=disk, amount=amount)
  SubmitOpCode(op)
  return 0


Iustin Pop's avatar
Iustin Pop committed
404
def StartupInstance(opts, args):
405
  """Startup an instance.
Iustin Pop's avatar
Iustin Pop committed
406
407
408
409
410
411

  Args:
    opts - class with options as members
    args - list containing a single element, the instance name

  """
412
413
414
  if opts.multi_mode is None:
    opts.multi_mode = _SHUTDOWN_INSTANCES
  inames = _ExpandMultiNames(opts.multi_mode, args)
415
416
  if not inames:
    raise errors.OpPrereqError("Selection filter does not match any instances")
417
418
419
420
  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
421
422
423
424
425
426
427
  for name in inames:
    op = opcodes.OpStartupInstance(instance_name=name,
                                   force=opts.force,
                                   extra_args=opts.extra_args)
    if multi_on:
      logger.ToStdout("Starting up %s" % name)
    SubmitOpCode(op)
Iustin Pop's avatar
Iustin Pop committed
428
429
  return 0

430

431
432
433
434
435
436
437
438
439
440
441
def RebootInstance(opts, args):
  """Reboot an instance

  Args:
    opts - class with options as members
    args - list containing a single element, the instance name

  """
  if opts.multi_mode is None:
    opts.multi_mode = _SHUTDOWN_INSTANCES
  inames = _ExpandMultiNames(opts.multi_mode, args)
442
443
  if not inames:
    raise errors.OpPrereqError("Selection filter does not match any instances")
444
445
446
447
448
449
450
451
452
453
454
  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)

    SubmitOpCode(op)
  return 0
Iustin Pop's avatar
Iustin Pop committed
455

456

Iustin Pop's avatar
Iustin Pop committed
457
458
459
460
461
462
463
464
def ShutdownInstance(opts, args):
  """Shutdown an instance.

  Args:
    opts - class with options as members
    args - list containing a single element, the instance name

  """
465
466
467
  if opts.multi_mode is None:
    opts.multi_mode = _SHUTDOWN_INSTANCES
  inames = _ExpandMultiNames(opts.multi_mode, args)
468
469
  if not inames:
    raise errors.OpPrereqError("Selection filter does not match any instances")
470
471
472
473
  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
474
475
476
477
478
  for name in inames:
    op = opcodes.OpShutdownInstance(instance_name=name)
    if multi_on:
      logger.ToStdout("Shutting down %s" % name)
    SubmitOpCode(op)
Iustin Pop's avatar
Iustin Pop committed
479
480
481
482
483
484
485
486
487
488
489
490
  return 0


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

  Args:
    opts - class with options as members
    args - list with a single element, the instance name

  """
  instance_name = args[0]
491
  new_2ndary = opts.new_secondary
492
  iallocator = opts.iallocator
493
494
495
496
497
498
499
500
  if opts.disks is None:
    disks = ["sda", "sdb"]
  else:
    disks = opts.disks.split(",")
  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
501
    if new_2ndary is not None or iallocator is not None:
502
503
      raise errors.OpPrereqError("Can't change secondary node on primary disk"
                                 " replacement")
504
505
  elif opts.on_secondary is not None or iallocator is not None:
    # only on secondary
506
507
508
    mode = constants.REPLACE_DISK_SEC

  op = opcodes.OpReplaceDisks(instance_name=args[0], disks=disks,
509
510
                              remote_node=new_2ndary, mode=mode,
                              iallocator=iallocator)
Iustin Pop's avatar
Iustin Pop committed
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
  SubmitOpCode(op)
  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.

  Args:
    opts - class with options as members
    args - list with a single element, the instance name
  Opts used:
    force - whether to failover without asking questions.

  """
528
529
  instance_name = args[0]
  force = opts.force
Iustin Pop's avatar
Iustin Pop committed
530

531
532
533
534
535
536
  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
537

538
539
540
541
  op = opcodes.OpFailoverInstance(instance_name=instance_name,
                                  ignore_consistency=opts.ignore_consistency)
  SubmitOpCode(op)
  return 0
Iustin Pop's avatar
Iustin Pop committed
542
543
544
545
546
547
548
549
550
551
552
553
554


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

  Args:
    opts - class with options as members
    args - list with a single element, the instance name

  """
  instance_name = args[0]

  op = opcodes.OpConnectConsole(instance_name=instance_name)
555
  cmd = SubmitOpCode(op)
556
557
558
559
560
561
562
563
564
565

  if opts.show_command:
    print utils.ShellQuoteArgs(cmd)
  else:
    try:
      os.execvp(cmd[0], cmd)
    finally:
      sys.stderr.write("Can't run console command %s with arguments:\n'%s'" %
                       (cmd, " ".join(argv)))
      os._exit(1)
Iustin Pop's avatar
Iustin Pop committed
566
567
568
569
570
571
572
573
574
575


def _FormatBlockDevInfo(buf, dev, indent_level):
  """Show block device information.

  This is only used by ShowInstanceConfig(), but it's too big to be
  left for an inline definition.

  """
  def helper(buf, dtype, status):
Alexander Schreiber's avatar
Alexander Schreiber committed
576
    """Format one line for physical device status."""
Iustin Pop's avatar
Iustin Pop committed
577
578
579
    if not status:
      buf.write("not active\n")
    else:
580
      (path, major, minor, syncp, estt, degr, ldisk) = status
581
582
583
584
585
586
587
588
589
590
591
      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))
592
      if dtype in (constants.LD_DRBD8, ):
Iustin Pop's avatar
Iustin Pop committed
593
594
595
596
597
598
599
600
601
602
603
604
        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"
605
606
607
608
609
        if ldisk:
          ldisk_text = " *MISSING DISK*"
        else:
          ldisk_text = ""
        buf.write(" %s, status %s%s" % (sync_text, degr_text, ldisk_text))
610
      elif dtype == constants.LD_LV:
611
612
        if ldisk:
          ldisk_text = " *FAILED* (failed drive?)"
613
        else:
614
615
          ldisk_text = ""
        buf.write(ldisk_text)
Iustin Pop's avatar
Iustin Pop committed
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
      buf.write("\n")

  if dev["iv_name"] is not None:
    data = "  - %s, " % dev["iv_name"]
  else:
    data = "  - "
  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))
  buf.write("%*s    primary:   " % (2*indent_level, ""))
  helper(buf, dev["dev_type"], dev["pstatus"])

  if dev["sstatus"]:
    buf.write("%*s    secondary: " % (2*indent_level, ""))
    helper(buf, dev["dev_type"], dev["sstatus"])

  if dev["children"]:
    for child in dev["children"]:
      _FormatBlockDevInfo(buf, child, indent_level+1)


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

  """
  retcode = 0
  op = opcodes.OpQueryInstanceData(instances=args)
  result = SubmitOpCode(op)
647
  hvm_parameters = ("hvm_acpi", "hvm_pae", "hvm_cdrom_image_path",
648
                    "hvm_boot_order", "hvm_nic_type", "hvm_disk_type")
649
650

  pvm_parameters = ("kernel_path", "initrd_path")
Iustin Pop's avatar
Iustin Pop committed
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666

  if not result:
    logger.ToStdout("No instances.")
    return 1

  buf = StringIO()
  retcode = 0
  for instance_name in result:
    instance = result[instance_name]
    buf.write("Instance name: %s\n" % instance["name"])
    buf.write("State: configured to be %s, actual state is %s\n" %
              (instance["config_state"], instance["run_state"]))
    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"])
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
    if instance.has_key("network_port"):
      buf.write("  Allocated network port: %s\n" % instance["network_port"])
    if False not in map(instance.has_key, pvm_parameters):
      if instance["kernel_path"] in (None, constants.VALUE_DEFAULT):
        kpath = "(default: %s)" % constants.XEN_KERNEL
      else:
        kpath = instance["kernel_path"]
      buf.write("  Kernel path: %s\n" % kpath)
      if instance["initrd_path"] in (None, constants.VALUE_DEFAULT):
        initrd = "(default: %s)" % constants.XEN_INITRD
      elif instance["initrd_path"] == constants.VALUE_NONE:
        initrd = "(none)"
      else:
        initrd = instance["initrd_path"]
      buf.write("       initrd: %s\n" % initrd)
    if False not in map(instance.has_key, hvm_parameters):
      buf.write("  HVM:\n")
      buf.write("    - boot order: %s\n" % instance["hvm_boot_order"])
      buf.write("    - ACPI support: %s\n" % instance["hvm_acpi"])
      buf.write("    - PAE support: %s\n" % instance["hvm_pae"])
      buf.write("    - virtual CDROM: %s\n" % instance["hvm_cdrom_image_path"])
688
689
      buf.write("    - virtual NIC type: %s\n" %  instance["hvm_nic_type"])
      buf.write("    - virtual disk type: %s\n" %  instance["hvm_disk_type"])
690
691
    if instance.has_key("vnc_bind_address"):
      buf.write("  VNC bind address: %s\n" % instance["vnc_bind_address"])
Iustin Pop's avatar
Iustin Pop committed
692
    buf.write("  Hardware:\n")
693
    buf.write("    - VCPUs: %d\n" % instance["vcpus"])
Iustin Pop's avatar
Iustin Pop committed
694
695
696
697
698
699
700
701
702
703
704
705
706
707
    buf.write("    - memory: %dMiB\n" % instance["memory"])
    buf.write("    - NICs: %s\n" %
        ", ".join(["{MAC: %s, IP: %s, bridge: %s}" %
                   (mac, ip, bridge)
                     for mac, ip, bridge in instance["nics"]]))
    buf.write("  Block devices:\n")

    for device in instance["disks"]:
      _FormatBlockDevInfo(buf, device, 1)

  logger.ToStdout(buf.getvalue().rstrip('\n'))
  return retcode


708
def SetInstanceParams(opts, args):
Iustin Pop's avatar
Iustin Pop committed
709
710
711
712
713
714
715
716
717
718
  """Modifies an instance.

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

  Args:
    opts - class with options as members
    args - list with a single element, the instance name
  Opts used:
    memory - the new memory size
    vcpus - the new number of cpus
719
    mac - the new MAC address of the instance
Iustin Pop's avatar
Iustin Pop committed
720
721

  """
722
  if not (opts.mem or opts.vcpus or opts.ip or opts.bridge or opts.mac or
723
          opts.kernel_path or opts.initrd_path or opts.hvm_boot_order or
724
          opts.hvm_acpi or opts.hvm_pae or opts.hvm_cdrom_image_path or
725
          opts.vnc_bind_address or opts.hvm_nic_type or opts.hvm_disk_type):
Iustin Pop's avatar
Iustin Pop committed
726
727
728
    logger.ToStdout("Please give at least one of the parameters.")
    return 1

729
730
  kernel_path = _TransformPath(opts.kernel_path)
  initrd_path = _TransformPath(opts.initrd_path)
731
  if opts.hvm_boot_order == 'default':
732
733
734
    hvm_boot_order = constants.VALUE_DEFAULT
  else:
    hvm_boot_order = opts.hvm_boot_order
735

736
737
738
739
  if opts.hvm_acpi is None:
    hvm_acpi = opts.hvm_acpi
  else:
    hvm_acpi = opts.hvm_acpi == _VALUE_TRUE
740

741
742
  if opts.hvm_pae is None:
    hvm_pae = opts.hvm_pae
743
  else:
744
    hvm_pae = opts.hvm_pae == _VALUE_TRUE
745

746
747
748
749
750
751
752
753
754
755
  if opts.hvm_nic_type == constants.VALUE_NONE:
    hvm_nic_type = None
  else:
    hvm_nic_type = opts.hvm_nic_type

  if opts.hvm_disk_type == constants.VALUE_NONE:
    hvm_disk_type = None
  else:
    hvm_disk_type = opts.hvm_disk_type

756
757
758
759
760
  op = opcodes.OpSetInstanceParams(instance_name=args[0], mem=opts.mem,
                                   vcpus=opts.vcpus, ip=opts.ip,
                                   bridge=opts.bridge, mac=opts.mac,
                                   kernel_path=opts.kernel_path,
                                   initrd_path=opts.initrd_path,
761
762
                                   hvm_boot_order=hvm_boot_order,
                                   hvm_acpi=hvm_acpi, hvm_pae=hvm_pae,
763
764
                                   hvm_cdrom_image_path=
                                   opts.hvm_cdrom_image_path,
765
766
767
                                   vnc_bind_address=opts.vnc_bind_address,
                                   hvm_nic_type=hvm_nic_type,
                                   hvm_disk_type=hvm_disk_type)
768

Iustin Pop's avatar
Iustin Pop committed
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
  result = SubmitOpCode(op)

  if result:
    logger.ToStdout("Modified instance %s" % args[0])
    for param, data in result:
      logger.ToStdout(" - %-5s -> %s" % (param, data))
    logger.ToStdout("Please don't forget that these parameters take effect"
                    " only at the next start of the instance.")
  return 0


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

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

787
# multi-instance selection options
788
789
790
791
792
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)

793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
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
814
815
816
# this is defined separately due to readability only
add_opts = [
  DEBUG_OPT,
817
818
819
  make_option("-n", "--node", dest="node",
              help="Target node and optional secondary node",
              metavar="<pnode>[:<snode>]"),
820
821
  cli_option("-s", "--os-size", dest="size", help="Disk size, in MiB unless"
             " a suffix is used",
Iustin Pop's avatar
Iustin Pop committed
822
             default=20 * 1024, type="unit", metavar="<size>"),
823
824
  cli_option("--swap-size", dest="swap", help="Swap size, in MiB unless a"
             " suffix is used",
Iustin Pop's avatar
Iustin Pop committed
825
             default=4 * 1024, type="unit", metavar="<size>"),
826
  os_opt,
827
  cli_option("-m", "--memory", dest="mem", help="Memory size (in MiB)",
Iustin Pop's avatar
Iustin Pop committed
828
829
830
831
              default=128, type="unit", metavar="<mem>"),
  make_option("-p", "--cpu", dest="vcpus", help="Number of virtual CPUs",
              default=1, type="int", metavar="<PROC>"),
  make_option("-t", "--disk-template", dest="disk_template",
832
              help="Custom disk setup (diskless, file, plain or drbd)",
833
              default=None, metavar="TEMPL"),
Iustin Pop's avatar
Iustin Pop committed
834
835
836
  make_option("-i", "--ip", dest="ip",
              help="IP address ('none' [default], 'auto', or specify address)",
              default='none', type="string", metavar="<ADDRESS>"),
837
838
839
  make_option("--mac", dest="mac",
              help="MAC address ('auto' [default], or specify address)",
              default='auto', type="string", metavar="<MACADDRESS>"),
Iustin Pop's avatar
Iustin Pop committed
840
841
842
843
  make_option("--no-wait-for-sync", dest="wait_for_sync", default=True,
              action="store_false", help="Don't wait for sync (DANGEROUS!)"),
  make_option("-b", "--bridge", dest="bridge",
              help="Bridge to connect this instance to",
844
845
846
847
848
849
850
              default=None, metavar="<bridge>"),
  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)"),
851
852
853
854
855
856
857
858
  make_option("--kernel", dest="kernel_path",
              help="Path to the instances' kernel (or 'default')",
              default=None,
              type="string", metavar="<FILENAME>"),
  make_option("--initrd", dest="initrd_path",
              help="Path to the instances' initrd (or 'none', or 'default')",
              default=None,
              type="string", metavar="<FILENAME>"),
859
  make_option("--hvm-boot-order", dest="hvm_boot_order",
860
              help="Boot device order for HVM (one or more of [acdn])",
861
              default=None, type="string", metavar="<BOOTORDER>"),
862
863
864
865
866
  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"
867
868
869
870
              " 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"),
871
872
873
  make_option("--hvm-acpi", dest="hvm_acpi",
              help="ACPI support for HVM (true|false)",
              metavar="<BOOL>", choices=["true", "false"]),
874
875
876
877
878
879
880
881
882
883
884
885
886
  make_option("--hvm-nic-type", dest="hvm_nic_type",
              help="Type of virtual NIC for HVM "
              "(rtl8139,ne2k_pci,ne2k_isa,paravirtual)",
              metavar="NICTYPE", choices=[constants.HT_HVM_NIC_RTL8139,
                                          constants.HT_HVM_NIC_NE2K_PCI,
                                          constants.HT_HVM_NIC_NE2K_ISA,
                                          constants.HT_HVM_DEV_PARAVIRTUAL],
              default=constants.HT_HVM_NIC_RTL8139),
  make_option("--hvm-disk-type", dest="hvm_disk_type",
              help="Type of virtual disks for HVM (ioemu,paravirtual)",
              metavar="DISKTYPE", choices=[constants.HT_HVM_DEV_IOEMU,
                                           constants.HT_HVM_DEV_PARAVIRTUAL],
              default=constants.HT_HVM_DEV_IOEMU,),
887
888
889
890
891
892
893
894
895
  make_option("--hvm-pae", dest="hvm_pae",
              help="PAE support for HVM (true|false)",
              metavar="<BOOL>", choices=["true", "false"]),
  make_option("--hvm-cdrom-image-path", dest="hvm_cdrom_image_path",
              help="CDROM image path for HVM (absolute path or None)",
              default=None, type="string", metavar="<CDROMIMAGE>"),
  make_option("--vnc-bind-address", dest="vnc_bind_address",
              help="bind address for VNC (IP address)",
              default=None, type="string", metavar="<VNCADDRESS>"),
Iustin Pop's avatar
Iustin Pop committed
896
897
898
899
  ]

commands = {
  'add': (AddInstance, ARGS_ONE, add_opts,
900
          "[...] -t disk-type -n node[:secondary-node] -o os-type <name>",
Iustin Pop's avatar
Iustin Pop committed
901
          "Creates and adds a new instance to the cluster"),
902
903
904
905
906
  '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"))],
907
              "[--show-cmd] <instance>",
Iustin Pop's avatar
Iustin Pop committed
908
              "Opens a console on the specified instance"),
909
  'failover': (FailoverInstance, ARGS_ONE,
910
               [DEBUG_OPT, FORCE_OPT,
Iustin Pop's avatar
Iustin Pop committed
911
912
913
914
915
                make_option("--ignore-consistency", dest="ignore_consistency",
                            action="store_true", default=False,
                            help="Ignore the consistency of the disks on"
                            " the secondary"),
                ],
916
               "[-f] <instance>",
Iustin Pop's avatar
Iustin Pop committed
917
               "Stops the instance and starts it on the backup node, using"
918
               " the remote mirror (only for instances of type drbd)"),
919
  'info': (ShowInstanceConfig, ARGS_ANY, [DEBUG_OPT], "[<instance>...]",
Iustin Pop's avatar
Iustin Pop committed
920
921
           "Show information on the specified instance"),
  'list': (ListInstances, ARGS_NONE,
922
           [DEBUG_OPT, NOHDR_OPT, SEP_OPT, USEUNITS_OPT, FIELDS_OPT], "",
923
924
           "Lists the instances and their status. The available fields are"
           " (see the man page for details): status, oper_state, oper_ram,"
925
926
           " name, os, pnode, snodes, admin_state, admin_ram, disk_template,"
           " ip, mac, bridge, sda_size, sdb_size, vcpus. The default field"
927
928
           " list is (in order): %s." % ", ".join(_LIST_DEF_FIELDS),
           ),
929
  'reinstall': (ReinstallInstance, ARGS_ONE, [DEBUG_OPT, FORCE_OPT, os_opt],
930
                "[-f] <instance>", "Reinstall a stopped instance"),
Iustin Pop's avatar
Iustin Pop committed
931
932
933
934
935
936
937
938
  '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.)")),
              ],
939
             "[-f] <instance>", "Shuts down the instance and removes it"),
940
941
942
943
944
945
946
  '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"),
              ],
947
             "<instance> <new_name>", "Rename the instance"),
Iustin Pop's avatar
Iustin Pop committed
948
949
950
  'replace-disks': (ReplaceDisks, ARGS_ONE,
                    [DEBUG_OPT,
                     make_option("-n", "--new-secondary", dest="new_secondary",
951
952
953
954
955
                                 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"
956
                                       " node (only for the drbd template)")),
957
958
959
                     make_option("-s", "--on-secondary", dest="on_secondary",
                                 default=False, action="store_true",
                                 help=("Replace the disk(s) on the secondary"
960
                                       " node (only for the drbd template)")),
961
962
963
964
                     make_option("--disks", dest="disks", default=None,
                                 help=("Comma-separated list of disks"
                                       " to replace (e.g. sda) (optional,"
                                       " defaults to all disks")),
965
966
967
968
969
970
                     make_option("--iallocator", metavar="<NAME>",
                                 help="Select new secondary for the instance"
                                 " automatically using the"
                                 " <NAME> iallocator plugin (enables"
                                 " secondary node replacement)",
                                 default=None, type="string"),
971
                     ],
972
                    "[-s|-p|-n NODE] <instance>",
Iustin Pop's avatar
Iustin Pop committed
973
                    "Replaces all disks for the instance"),
974
  'modify': (SetInstanceParams, ARGS_ONE,
975
             [DEBUG_OPT, FORCE_OPT,
Iustin Pop's avatar
Iustin Pop committed
976
977
978
979
980
981
982
983
984
985
986
              cli_option("-m", "--memory", dest="mem",
                         help="Memory size",
                         default=None, type="unit", metavar="<mem>"),
              make_option("-p", "--cpu", dest="vcpus",
                          help="Number of virtual CPUs",
                          default=None, type="int", metavar="<PROC>"),
              make_option("-i", "--ip", dest="ip",
                          help="IP address ('none' or numeric IP)",
                          default=None, type="string", metavar="<ADDRESS>"),
              make_option("-b", "--bridge", dest="bridge",
                          help="Bridge to connect this instance to",
987
                          default=None, type="string", metavar="<bridge>"),
988
989
990
              make_option("--mac", dest="mac",
                          help="MAC address", default=None,
                          type="string", metavar="<MACADDRESS>"),
991
992
993
994
995
996
997
998
              make_option("--kernel", dest="kernel_path",
                          help="Path to the instances' kernel (or"
                          " 'default')", default=None,
                          type="string", metavar="<FILENAME>"),
              make_option("--initrd", dest="initrd_path",
                          help="Path to the instances' initrd (or 'none', or"
                          " 'default')", default=None,
                          type="string", metavar="<FILENAME>"),
999
1000
1001
1002
              make_option("--hvm-boot-order", dest="hvm_boot_order",
                          help="boot device order for HVM"
                          "(either one or more of [acdn] or 'default')",
                          default=None, type="string", metavar="<BOOTORDER>"),
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
              make_option("--hvm-acpi", dest="hvm_acpi",
                          help="ACPI support for HVM (true|false)",
                          metavar="<BOOL>", choices=["true", "false"]),
              make_option("--hvm-pae", dest="hvm_pae",
                          help="PAE support for HVM (true|false)",
                          metavar="<BOOL>", choices=["true", "false"]),
              make_option("--hvm-cdrom-image-path",
                          dest="hvm_cdrom_image_path",
                          help="CDROM image path for HVM"
                          "(absolute path or None)",
                          default=None, type="string", metavar="<CDROMIMAGE>"),
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
              make_option("--hvm-nic-type", dest="hvm_nic_type",
                          help="Type of virtual NIC for HVM "
                          "(rtl8139,ne2k_pci,ne2k_isa,paravirtual)",
                          metavar="NICTYPE",
                          choices=[constants.HT_HVM_NIC_RTL8139,
                                   constants.HT_HVM_NIC_NE2K_PCI,
                                   constants.HT_HVM_NIC_NE2K_ISA,
                                   constants.HT_HVM_DEV_PARAVIRTUAL],
                          default=None),
              make_option("--hvm-disk-type", dest="hvm_disk_type",
                          help="Type of virtual disks for HVM "
                          "(ioemu,paravirtual)",
                          metavar="DISKTYPE",
                          choices=[constants.HT_HVM_DEV_IOEMU,
                                   constants.HT_HVM_DEV_PARAVIRTUAL],
                          default=None),
1030
1031
1032
              make_option("--vnc-bind-address", dest="vnc_bind_address",
                          help="bind address for VNC (IP address)",
                          default=None, type="string", metavar="<VNCADDRESS>"),
Iustin Pop's avatar
Iustin Pop committed
1033
              ],
1034
             "<instance>", "Alters the parameters of an instance"),
1035
1036
  'shutdown': (ShutdownInstance, ARGS_ANY,
               [DEBUG_OPT, m_node_opt, m_pri_node_opt, m_sec_node_opt,
1037
                m_clust_opt, m_inst_opt, m_force_multi],
1038
               "<instance>", "Stops an instance"),
1039
  'startup': (StartupInstance, ARGS_ANY,
1040
              [DEBUG_OPT, FORCE_OPT, m_force_multi,
Iustin Pop's avatar
Iustin Pop committed
1041
1042
1043
               make_option("-e", "--extra", dest="extra_args",
                           help="Extra arguments for the instance's kernel",
                           default=None, type="string", metavar="<PARAMS>"),
1044
1045
               m_node_opt, m_pri_node_opt, m_sec_node_opt,
               m_clust_opt, m_inst_opt,
Iustin Pop's avatar
Iustin Pop committed
1046
               ],
1047
            "<instance>", "Starts an instance"),
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063

  'reboot': (RebootInstance, ARGS_ANY,
              [DEBUG_OPT, m_force_multi,
               make_option("-e", "--extra", dest="extra_args",
                           help="Extra arguments for the instance's kernel",
                           default=None, type="string", metavar="<PARAMS>"),
               make_option("-t", "--type", dest="reboot_type",
                           help="Type of reboot: soft/hard/full",
                           default=constants.INSTANCE_REBOOT_SOFT,
                           type="string", metavar="<REBOOT>"),
               make_option("--ignore-secondaries", dest="ignore_secondaries",
                           default=False, action="store_true",
                           help="Ignore errors from secondaries"),
               m_node_opt, m_pri_node_opt, m_sec_node_opt,
               m_clust_opt, m_inst_opt,
               ],
1064
            "<instance>", "Reboots an instance"),
Iustin Pop's avatar
Iustin Pop committed
1065
  'activate-disks': (ActivateDisks, ARGS_ONE, [DEBUG_OPT],
1066
                     "<instance>",
Iustin Pop's avatar
Iustin Pop committed
1067
1068
                     "Activate an instance's disks"),
  'deactivate-disks': (DeactivateDisks, ARGS_ONE, [DEBUG_OPT],
1069
                       "<instance>",
Iustin Pop's avatar
Iustin Pop committed
1070
                       "Deactivate an instance's disks"),
Iustin Pop's avatar
Iustin Pop committed
1071
1072
  'grow-disk': (GrowDisk, ARGS_FIXED(3), [DEBUG_OPT],
                "<instance> <disk> <size>", "Grow an instance's disk"),
1073
  'list-tags': (ListTags, ARGS_ONE, [DEBUG_OPT],
1074
                "<node_name>", "List the tags of the given instance"),
1075
  'add-tags': (AddTags, ARGS_ATLEAST(1), [DEBUG_OPT, TAG_SRC_OPT],
1076
               "<node_name> tag...", "Add tags to the given instance"),
1077
  'remove-tags': (RemoveTags, ARGS_ATLEAST(1), [DEBUG_OPT, TAG_SRC_OPT],
1078
                  "<node_name> tag...", "Remove tags from given instance"),
Iustin Pop's avatar
Iustin Pop committed
1079
1080
  }

Guido Trotter's avatar
Guido Trotter committed
1081
1082
aliases = {
  'activate_block_devs': 'activate-disks',
1083
  'replace_disks': 'replace-disks',
1084
1085
  'start': 'startup',
  'stop': 'shutdown',
Guido Trotter's avatar
Guido Trotter committed
1086
1087
  }

Iustin Pop's avatar
Iustin Pop committed
1088
if __name__ == '__main__':
Guido Trotter's avatar
Guido Trotter committed
1089
  sys.exit(GenericMain(commands, aliases=aliases,
1090
                       override={"tag_type": constants.TAG_INSTANCE}))