gnt-instance 38.8 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
288
289
                                hvm_acpi=hvm_acpi, hvm_pae=hvm_pae,
                                hvm_cdrom_image_path=hvm_cdrom_image_path,
                                vnc_bind_address=opts.vnc_bind_address)

Iustin Pop's avatar
Iustin Pop committed
290
291
292
293
  SubmitOpCode(op)
  return 0


294
295
296
297
298
299
300
301
302
303
304
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:
305
306
    usertext = ("This will reinstall the instance %s and remove"
                " all data. Continue?") % instance_name
307
    if not AskUser(usertext):
308
309
      return 1

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

  return 0


Iustin Pop's avatar
Iustin Pop committed
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
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
332
    if not AskUser(usertext):
Iustin Pop's avatar
Iustin Pop committed
333
334
      return 1

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


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

  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
357
358
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
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
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
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
402
def StartupInstance(opts, args):
403
  """Startup an instance.
Iustin Pop's avatar
Iustin Pop committed
404
405
406
407
408
409

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

  """
410
411
412
  if opts.multi_mode is None:
    opts.multi_mode = _SHUTDOWN_INSTANCES
  inames = _ExpandMultiNames(opts.multi_mode, args)
413
414
  if not inames:
    raise errors.OpPrereqError("Selection filter does not match any instances")
415
416
417
418
  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
419
420
421
422
423
424
425
  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
426
427
  return 0

428

429
430
431
432
433
434
435
436
437
438
439
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)
440
441
  if not inames:
    raise errors.OpPrereqError("Selection filter does not match any instances")
442
443
444
445
446
447
448
449
450
451
452
  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
453

454

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

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

  """
463
464
465
  if opts.multi_mode is None:
    opts.multi_mode = _SHUTDOWN_INSTANCES
  inames = _ExpandMultiNames(opts.multi_mode, args)
466
467
  if not inames:
    raise errors.OpPrereqError("Selection filter does not match any instances")
468
469
470
471
  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
472
473
474
475
476
  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
477
478
479
480
481
482
483
484
485
486
487
488
  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]
489
  new_2ndary = opts.new_secondary
490
  iallocator = opts.iallocator
491
492
493
494
495
496
497
498
  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
499
    if new_2ndary is not None or iallocator is not None:
500
501
      raise errors.OpPrereqError("Can't change secondary node on primary disk"
                                 " replacement")
502
503
  elif opts.on_secondary is not None or iallocator is not None:
    # only on secondary
504
505
506
    mode = constants.REPLACE_DISK_SEC

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

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

529
530
531
532
533
534
  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
535

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


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)
553
  cmd = SubmitOpCode(op)
554
555
556
557
558
559
560
561
562
563

  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
564
565
566
567
568
569
570
571
572
573


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
574
    """Format one line for physical device status."""
Iustin Pop's avatar
Iustin Pop committed
575
576
577
    if not status:
      buf.write("not active\n")
    else:
578
      (path, major, minor, syncp, estt, degr, ldisk) = status
579
580
581
582
583
584
585
586
587
588
589
      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))
590
      if dtype in (constants.LD_DRBD8, ):
Iustin Pop's avatar
Iustin Pop committed
591
592
593
594
595
596
597
598
599
600
601
602
        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"
603
604
605
606
607
        if ldisk:
          ldisk_text = " *MISSING DISK*"
        else:
          ldisk_text = ""
        buf.write(" %s, status %s%s" % (sync_text, degr_text, ldisk_text))
608
      elif dtype == constants.LD_LV:
609
610
        if ldisk:
          ldisk_text = " *FAILED* (failed drive?)"
611
        else:
612
613
          ldisk_text = ""
        buf.write(ldisk_text)
Iustin Pop's avatar
Iustin Pop committed
614
615
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
      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)
645
646
647
648
  hvm_parameters = ("hvm_acpi", "hvm_pae", "hvm_cdrom_image_path",
                    "hvm_boot_order")

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

  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"])
665
666
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"])
    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
688
    buf.write("  Hardware:\n")
689
    buf.write("    - VCPUs: %d\n" % instance["vcpus"])
Iustin Pop's avatar
Iustin Pop committed
690
691
692
693
694
695
696
697
698
699
700
701
702
703
    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


704
def SetInstanceParams(opts, args):
Iustin Pop's avatar
Iustin Pop committed
705
706
707
708
709
710
711
712
713
714
  """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
715
    mac - the new MAC address of the instance
Iustin Pop's avatar
Iustin Pop committed
716
717

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

725
726
  kernel_path = _TransformPath(opts.kernel_path)
  initrd_path = _TransformPath(opts.initrd_path)
727
  if opts.hvm_boot_order == 'default':
728
729
730
    hvm_boot_order = constants.VALUE_DEFAULT
  else:
    hvm_boot_order = opts.hvm_boot_order
731

732
733
734
735
  if opts.hvm_acpi is None:
    hvm_acpi = opts.hvm_acpi
  else:
    hvm_acpi = opts.hvm_acpi == _VALUE_TRUE
736

737
738
  if opts.hvm_pae is None:
    hvm_pae = opts.hvm_pae
739
  else:
740
    hvm_pae = opts.hvm_pae == _VALUE_TRUE
741

742
743
744
745
746
  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,
747
748
                                   hvm_boot_order=hvm_boot_order,
                                   hvm_acpi=hvm_acpi, hvm_pae=hvm_pae,
749
750
                                   hvm_cdrom_image_path=
                                   opts.hvm_cdrom_image_path,
751
752
                                   vnc_bind_address=opts.vnc_bind_address)

Iustin Pop's avatar
Iustin Pop committed
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
  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>")

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

771
# multi-instance selection options
772
773
774
775
776
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)

777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
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
798
799
800
# this is defined separately due to readability only
add_opts = [
  DEBUG_OPT,
801
802
803
  make_option("-n", "--node", dest="node",
              help="Target node and optional secondary node",
              metavar="<pnode>[:<snode>]"),
804
805
  cli_option("-s", "--os-size", dest="size", help="Disk size, in MiB unless"
             " a suffix is used",
Iustin Pop's avatar
Iustin Pop committed
806
             default=20 * 1024, type="unit", metavar="<size>"),
807
808
  cli_option("--swap-size", dest="swap", help="Swap size, in MiB unless a"
             " suffix is used",
Iustin Pop's avatar
Iustin Pop committed
809
             default=4 * 1024, type="unit", metavar="<size>"),
810
  os_opt,
811
  cli_option("-m", "--memory", dest="mem", help="Memory size (in MiB)",
Iustin Pop's avatar
Iustin Pop committed
812
813
814
815
              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",
816
              help="Custom disk setup (diskless, file, plain or drbd)",
817
              default=None, metavar="TEMPL"),
Iustin Pop's avatar
Iustin Pop committed
818
819
820
  make_option("-i", "--ip", dest="ip",
              help="IP address ('none' [default], 'auto', or specify address)",
              default='none', type="string", metavar="<ADDRESS>"),
821
822
823
  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
824
825
826
827
  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",
828
829
830
831
832
833
834
              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)"),
835
836
837
838
839
840
841
842
  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>"),
843
  make_option("--hvm-boot-order", dest="hvm_boot_order",
844
              help="Boot device order for HVM (one or more of [acdn])",
845
              default=None, type="string", metavar="<BOOTORDER>"),
846
847
848
849
850
  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"
851
852
853
854
              " 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"),
855
856
857
858
859
860
861
862
863
864
865
866
  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>"),
  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
867
868
869
870
  ]

commands = {
  'add': (AddInstance, ARGS_ONE, add_opts,
871
          "[...] -t disk-type -n node[:secondary-node] -o os-type <name>",
Iustin Pop's avatar
Iustin Pop committed
872
          "Creates and adds a new instance to the cluster"),
873
874
875
876
877
  '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"))],
878
              "[--show-cmd] <instance>",
Iustin Pop's avatar
Iustin Pop committed
879
              "Opens a console on the specified instance"),
880
  'failover': (FailoverInstance, ARGS_ONE,
881
               [DEBUG_OPT, FORCE_OPT,
Iustin Pop's avatar
Iustin Pop committed
882
883
884
885
886
                make_option("--ignore-consistency", dest="ignore_consistency",
                            action="store_true", default=False,
                            help="Ignore the consistency of the disks on"
                            " the secondary"),
                ],
887
               "[-f] <instance>",
Iustin Pop's avatar
Iustin Pop committed
888
               "Stops the instance and starts it on the backup node, using"
889
               " the remote mirror (only for instances of type drbd)"),
890
  'info': (ShowInstanceConfig, ARGS_ANY, [DEBUG_OPT], "[<instance>...]",
Iustin Pop's avatar
Iustin Pop committed
891
892
           "Show information on the specified instance"),
  'list': (ListInstances, ARGS_NONE,
893
           [DEBUG_OPT, NOHDR_OPT, SEP_OPT, USEUNITS_OPT, FIELDS_OPT], "",
894
895
           "Lists the instances and their status. The available fields are"
           " (see the man page for details): status, oper_state, oper_ram,"
896
897
           " name, os, pnode, snodes, admin_state, admin_ram, disk_template,"
           " ip, mac, bridge, sda_size, sdb_size, vcpus. The default field"
898
899
           " list is (in order): %s." % ", ".join(_LIST_DEF_FIELDS),
           ),
900
  'reinstall': (ReinstallInstance, ARGS_ONE, [DEBUG_OPT, FORCE_OPT, os_opt],
901
                "[-f] <instance>", "Reinstall a stopped instance"),
Iustin Pop's avatar
Iustin Pop committed
902
903
904
905
906
907
908
909
  '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.)")),
              ],
910
             "[-f] <instance>", "Shuts down the instance and removes it"),
911
912
913
914
915
916
917
  '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"),
              ],
918
             "<instance> <new_name>", "Rename the instance"),
Iustin Pop's avatar
Iustin Pop committed
919
920
921
  'replace-disks': (ReplaceDisks, ARGS_ONE,
                    [DEBUG_OPT,
                     make_option("-n", "--new-secondary", dest="new_secondary",
922
923
924
925
926
                                 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"
927
                                       " node (only for the drbd template)")),
928
929
930
                     make_option("-s", "--on-secondary", dest="on_secondary",
                                 default=False, action="store_true",
                                 help=("Replace the disk(s) on the secondary"
931
                                       " node (only for the drbd template)")),
932
933
934
935
                     make_option("--disks", dest="disks", default=None,
                                 help=("Comma-separated list of disks"
                                       " to replace (e.g. sda) (optional,"
                                       " defaults to all disks")),
936
937
938
939
940
941
                     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"),
942
                     ],
943
                    "[-s|-p|-n NODE] <instance>",
Iustin Pop's avatar
Iustin Pop committed
944
                    "Replaces all disks for the instance"),
945
  'modify': (SetInstanceParams, ARGS_ONE,
946
             [DEBUG_OPT, FORCE_OPT,
Iustin Pop's avatar
Iustin Pop committed
947
948
949
950
951
952
953
954
955
956
957
              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",
958
                          default=None, type="string", metavar="<bridge>"),
959
960
961
              make_option("--mac", dest="mac",
                          help="MAC address", default=None,
                          type="string", metavar="<MACADDRESS>"),
962
963
964
965
966
967
968
969
              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>"),
970
971
972
973
              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>"),
974
975
976
977
978
979
980
981
982
983
984
985
986
987
              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>"),
              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
988
              ],
989
             "<instance>", "Alters the parameters of an instance"),
990
991
  'shutdown': (ShutdownInstance, ARGS_ANY,
               [DEBUG_OPT, m_node_opt, m_pri_node_opt, m_sec_node_opt,
992
                m_clust_opt, m_inst_opt, m_force_multi],
993
               "<instance>", "Stops an instance"),
994
  'startup': (StartupInstance, ARGS_ANY,
995
              [DEBUG_OPT, FORCE_OPT, m_force_multi,
Iustin Pop's avatar
Iustin Pop committed
996
997
998
               make_option("-e", "--extra", dest="extra_args",
                           help="Extra arguments for the instance's kernel",
                           default=None, type="string", metavar="<PARAMS>"),
999
1000
               m_node_opt, m_pri_node_opt, m_sec_node_opt,
               m_clust_opt, m_inst_opt,
Iustin Pop's avatar
Iustin Pop committed
1001
               ],
1002
            "<instance>", "Starts an instance"),
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018

  '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,
               ],
1019
            "<instance>", "Reboots an instance"),
Iustin Pop's avatar
Iustin Pop committed
1020
  'activate-disks': (ActivateDisks, ARGS_ONE, [DEBUG_OPT],
1021
                     "<instance>",
Iustin Pop's avatar
Iustin Pop committed
1022
1023
                     "Activate an instance's disks"),
  'deactivate-disks': (DeactivateDisks, ARGS_ONE, [DEBUG_OPT],
1024
                       "<instance>",
Iustin Pop's avatar
Iustin Pop committed
1025
                       "Deactivate an instance's disks"),
Iustin Pop's avatar
Iustin Pop committed
1026
1027
  'grow-disk': (GrowDisk, ARGS_FIXED(3), [DEBUG_OPT],
                "<instance> <disk> <size>", "Grow an instance's disk"),
1028
  'list-tags': (ListTags, ARGS_ONE, [DEBUG_OPT],
1029
                "<node_name>", "List the tags of the given instance"),
1030
  'add-tags': (AddTags, ARGS_ATLEAST(1), [DEBUG_OPT, TAG_SRC_OPT],
1031
               "<node_name> tag...", "Add tags to the given instance"),
1032
  'remove-tags': (RemoveTags, ARGS_ATLEAST(1), [DEBUG_OPT, TAG_SRC_OPT],
1033
                  "<node_name> tag...", "Remove tags from given instance"),
Iustin Pop's avatar
Iustin Pop committed
1034
1035
  }

Guido Trotter's avatar
Guido Trotter committed
1036
1037
aliases = {
  'activate_block_devs': 'activate-disks',
1038
  'replace_disks': 'replace-disks',
1039
1040
  'start': 'startup',
  'stop': 'shutdown',
Guido Trotter's avatar
Guido Trotter committed
1041
1042
  }

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