opcodes.py 48.4 KB
Newer Older
Iustin Pop's avatar
Iustin Pop committed
1
#
Iustin Pop's avatar
Iustin Pop committed
2
3
#

4
# Copyright (C) 2006, 2007, 2008, 2009, 2010, 2011 Google Inc.
Iustin Pop's avatar
Iustin Pop committed
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
#
# 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.


"""OpCodes module

This module implements the data structures which define the cluster
operations - the so-called opcodes.

Iustin Pop's avatar
Iustin Pop committed
27
28
Every operation which modifies the cluster state is expressed via
opcodes.
Iustin Pop's avatar
Iustin Pop committed
29
30
31
32
33
34
35

"""

# this are practically structures, so disable the message about too
# few public methods:
# pylint: disable-msg=R0903

36
import logging
37
import re
38
import operator
39

40
41
42
43
44
45
46
47
from ganeti import constants
from ganeti import errors
from ganeti import ht


# Common opcode attributes

#: output fields for a query operation
48
_POutputFields = ("output_fields", ht.NoDefault, ht.TListOf(ht.TNonEmptyString),
49
                  "Selected output fields")
50
51

#: the shutdown timeout
52
53
54
_PShutdownTimeout = \
  ("shutdown_timeout", constants.DEFAULT_SHUTDOWN_TIMEOUT, ht.TPositiveInt,
   "How long to wait for instance to shut down")
55
56

#: the force parameter
57
_PForce = ("force", False, ht.TBool, "Whether to force the operation")
58
59

#: a required instance name (for single-instance LUs)
60
61
_PInstanceName = ("instance_name", ht.NoDefault, ht.TNonEmptyString,
                  "Instance name")
62
63

#: Whether to ignore offline nodes
64
65
_PIgnoreOfflineNodes = ("ignore_offline_nodes", False, ht.TBool,
                        "Whether to ignore offline nodes")
66
67

#: a required node name (for single-node LUs)
68
_PNodeName = ("node_name", ht.NoDefault, ht.TNonEmptyString, "Node name")
69
70

#: a required node group name (for single-group LUs)
71
_PGroupName = ("group_name", ht.NoDefault, ht.TNonEmptyString, "Group name")
72
73
74

#: Migration type (live/non-live)
_PMigrationMode = ("mode", None,
75
                   ht.TOr(ht.TNone, ht.TElemOf(constants.HT_MIGRATION_MODES)),
76
                   "Migration mode")
77
78

#: Obsolete 'live' migration mode (boolean)
79
80
_PMigrationLive = ("live", None, ht.TMaybeBool,
                   "Legacy setting for live migration, do not use")
81
82

#: Tag type
83
_PTagKind = ("kind", ht.NoDefault, ht.TElemOf(constants.VALID_TAG_TYPES), None)
84
85

#: List of tag strings
86
_PTags = ("tags", ht.NoDefault, ht.TListOf(ht.TNonEmptyString), None)
87

88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
_PForceVariant = ("force_variant", False, ht.TBool,
                  "Whether to force an unknown OS variant")

_PWaitForSync = ("wait_for_sync", True, ht.TBool,
                 "Whether to wait for the disk to synchronize")

_PIgnoreConsistency = ("ignore_consistency", False, ht.TBool,
                       "Whether to ignore disk consistency")

_PStorageName = ("name", ht.NoDefault, ht.TMaybeString, "Storage name")

_PUseLocking = ("use_locking", False, ht.TBool,
                "Whether to use synchronization")

_PNameCheck = ("name_check", True, ht.TBool, "Whether to check name")

_PNodeGroupAllocPolicy = \
  ("alloc_policy", None,
   ht.TOr(ht.TNone, ht.TElemOf(constants.VALID_ALLOC_POLICIES)),
   "Instance allocation policy")

_PGroupNodeParams = ("ndparams", None, ht.TMaybeDict,
                     "Default node parameters for group")

112
_PQueryWhat = ("what", ht.NoDefault, ht.TElemOf(constants.QR_VIA_OP),
113
114
               "Resource(s) to query for")

115
116
117
_PEarlyRelease = ("early_release", False, ht.TBool,
                  "Whether to release locks as soon as possible")

118
119
_PIpCheckDoc = "Whether to ensure instance's IP address is inactive"

120
#: Do not remember instance state changes
121
122
_PNoRemember = ("no_remember", False, ht.TBool,
                "Do not remember the state change")
123

Michael Hanselmann's avatar
Michael Hanselmann committed
124
125
126
127
#: Target node for instance migration/failover
_PMigrationTargetNode = ("target_node", None, ht.TMaybeString,
                         "Target node for shared-storage instances")

128
129
130
131
_PStartupPaused = ("startup_paused", False, ht.TBool,
                   "Pause instance at startup")


132
133
134
#: OP_ID conversion regular expression
_OPID_RE = re.compile("([a-z])([A-Z])")

135
136
137
138
139
140
#: Utility function for L{OpClusterSetParams}
_TestClusterOsList = ht.TOr(ht.TNone,
  ht.TListOf(ht.TAnd(ht.TList, ht.TIsLength(2),
    ht.TMap(ht.WithDesc("GetFirstItem")(operator.itemgetter(0)),
            ht.TElemOf(constants.DDMS_VALUES)))))

141

142
143
144
145
146
# TODO: Generate check from constants.INIC_PARAMS_TYPES
#: Utility function for testing NIC definitions
_TestNicDef = ht.TDictOf(ht.TElemOf(constants.INIC_PARAMS),
                         ht.TOr(ht.TNone, ht.TNonEmptyString))

147
148
149
150
151
152
153
_SUMMARY_PREFIX = {
  "CLUSTER_": "C_",
  "GROUP_": "G_",
  "NODE_": "N_",
  "INSTANCE_": "I_",
  }

Michael Hanselmann's avatar
Michael Hanselmann committed
154
155
156
#: Attribute name for dependencies
DEPEND_ATTR = "depends"

157
158
159
#: Attribute name for comment
COMMENT_ATTR = "comment"

160

161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
def _NameToId(name):
  """Convert an opcode class name to an OP_ID.

  @type name: string
  @param name: the class name, as OpXxxYyy
  @rtype: string
  @return: the name in the OP_XXXX_YYYY format

  """
  if not name.startswith("Op"):
    return None
  # Note: (?<=[a-z])(?=[A-Z]) would be ideal, since it wouldn't
  # consume any input, and hence we would just have all the elements
  # in the list, one by one; but it seems that split doesn't work on
  # non-consuming input, hence we have to process the input string a
  # bit
  name = _OPID_RE.sub(r"\1,\2", name)
  elems = name.split(",")
  return "_".join(n.upper() for n in elems)

181
182
183
184
185
186
187
188
189
190
191
192
193
194
195

def RequireFileStorage():
  """Checks that file storage is enabled.

  While it doesn't really fit into this module, L{utils} was deemed too large
  of a dependency to be imported for just one or two functions.

  @raise errors.OpPrereqError: when file storage is disabled

  """
  if not constants.ENABLE_FILE_STORAGE:
    raise errors.OpPrereqError("File storage disabled at configure time",
                               errors.ECODE_INVAL)


196
197
198
199
200
201
202
203
204
205
206
207
208
209
def RequireSharedFileStorage():
  """Checks that shared file storage is enabled.

  While it doesn't really fit into this module, L{utils} was deemed too large
  of a dependency to be imported for just one or two functions.

  @raise errors.OpPrereqError: when shared file storage is disabled

  """
  if not constants.ENABLE_SHARED_FILE_STORAGE:
    raise errors.OpPrereqError("Shared file storage disabled at"
                               " configure time", errors.ECODE_INVAL)


210
211
212
@ht.WithDesc("CheckFileStorage")
def _CheckFileStorage(value):
  """Ensures file storage is enabled if used.
213
214

  """
215
  if value == constants.DT_FILE:
216
    RequireFileStorage()
217
218
  elif value == constants.DT_SHARED_FILE:
    RequireSharedFileStorage()
219
220
221
  return True


222
223
224
225
_CheckDiskTemplate = ht.TAnd(ht.TElemOf(constants.DISK_TEMPLATES),
                             _CheckFileStorage)


226
227
228
229
230
231
232
233
234
235
236
237
238
def _CheckStorageType(storage_type):
  """Ensure a given storage type is valid.

  """
  if storage_type not in constants.VALID_STORAGE_TYPES:
    raise errors.OpPrereqError("Unknown storage type: %s" % storage_type,
                               errors.ECODE_INVAL)
  if storage_type == constants.ST_FILE:
    RequireFileStorage()
  return True


#: Storage type parameter
239
240
_PStorageType = ("storage_type", ht.NoDefault, _CheckStorageType,
                 "Storage type")
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258


class _AutoOpParamSlots(type):
  """Meta class for opcode definitions.

  """
  def __new__(mcs, name, bases, attrs):
    """Called when a class should be created.

    @param mcs: The meta class
    @param name: Name of created class
    @param bases: Base classes
    @type attrs: dict
    @param attrs: Class attributes

    """
    assert "__slots__" not in attrs, \
      "Class '%s' defines __slots__ when it should use OP_PARAMS" % name
259
    assert "OP_ID" not in attrs, "Class '%s' defining OP_ID" % name
260

261
    attrs["OP_ID"] = _NameToId(name)
262
263
264
265
266

    # Always set OP_PARAMS to avoid duplicates in BaseOpCode.GetAllParams
    params = attrs.setdefault("OP_PARAMS", [])

    # Use parameter names as slots
267
    slots = [pname for (pname, _, _, _) in params]
268
269
270
271
272
273
274
275

    assert "OP_DSC_FIELD" not in attrs or attrs["OP_DSC_FIELD"] in slots, \
      "Class '%s' uses unknown field in OP_DSC_FIELD" % name

    attrs["__slots__"] = slots

    return type.__new__(mcs, name, bases, attrs)

276

Iustin Pop's avatar
Iustin Pop committed
277
class BaseOpCode(object):
278
279
  """A simple serializable object.

Iustin Pop's avatar
Iustin Pop committed
280
281
282
  This object serves as a parent class for OpCode without any custom
  field handling.

283
  """
284
285
  # pylint: disable-msg=E1101
  # as OP_ID is dynamically defined
286
287
  __metaclass__ = _AutoOpParamSlots

Iustin Pop's avatar
Iustin Pop committed
288
  def __init__(self, **kwargs):
Iustin Pop's avatar
Iustin Pop committed
289
290
291
292
293
294
295
296
    """Constructor for BaseOpCode.

    The constructor takes only keyword arguments and will set
    attributes on this object based on the passed arguments. As such,
    it means that you should not pass arguments which are not in the
    __slots__ attribute for this class.

    """
297
    slots = self._all_slots()
Iustin Pop's avatar
Iustin Pop committed
298
    for key in kwargs:
299
      if key not in slots:
300
        raise TypeError("Object %s doesn't support the parameter '%s'" %
301
                        (self.__class__.__name__, key))
Iustin Pop's avatar
Iustin Pop committed
302
303
      setattr(self, key, kwargs[key])

304
  def __getstate__(self):
Iustin Pop's avatar
Iustin Pop committed
305
306
307
308
309
310
311
312
313
    """Generic serializer.

    This method just returns the contents of the instance as a
    dictionary.

    @rtype:  C{dict}
    @return: the instance attributes and their values

    """
314
    state = {}
315
    for name in self._all_slots():
316
317
318
319
320
      if hasattr(self, name):
        state[name] = getattr(self, name)
    return state

  def __setstate__(self, state):
Iustin Pop's avatar
Iustin Pop committed
321
322
323
324
325
326
327
328
329
    """Generic unserializer.

    This method just restores from the serialized state the attributes
    of the current instance.

    @param state: the serialized opcode data
    @type state:  C{dict}

    """
330
331
332
333
    if not isinstance(state, dict):
      raise ValueError("Invalid data to __setstate__: expected dict, got %s" %
                       type(state))

334
    for name in self._all_slots():
Iustin Pop's avatar
Iustin Pop committed
335
      if name not in state and hasattr(self, name):
336
337
338
339
340
        delattr(self, name)

    for name in state:
      setattr(self, name, state[name])

341
342
343
344
345
346
347
348
349
350
  @classmethod
  def _all_slots(cls):
    """Compute the list of all declared slots for a class.

    """
    slots = []
    for parent in cls.__mro__:
      slots.extend(getattr(parent, "__slots__", []))
    return slots

351
352
353
354
355
356
357
358
359
360
  @classmethod
  def GetAllParams(cls):
    """Compute list of all parameters for an opcode.

    """
    slots = []
    for parent in cls.__mro__:
      slots.extend(getattr(parent, "OP_PARAMS", []))
    return slots

361
362
363
364
365
366
367
368
369
  def Validate(self, set_defaults):
    """Validate opcode parameters, optionally setting default values.

    @type set_defaults: bool
    @param set_defaults: Whether to set default values
    @raise errors.OpPrereqError: When a parameter value doesn't match
                                 requirements

    """
370
    for (attr_name, default, test, _) in self.GetAllParams():
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
      assert test == ht.NoType or callable(test)

      if not hasattr(self, attr_name):
        if default == ht.NoDefault:
          raise errors.OpPrereqError("Required parameter '%s.%s' missing" %
                                     (self.OP_ID, attr_name),
                                     errors.ECODE_INVAL)
        elif set_defaults:
          if callable(default):
            dval = default()
          else:
            dval = default
          setattr(self, attr_name, dval)

      if test == ht.NoType:
        # no tests here
        continue

      if set_defaults or hasattr(self, attr_name):
        attr_val = getattr(self, attr_name)
        if not test(attr_val):
          logging.error("OpCode %s, parameter %s, has invalid type %s/value %s",
                        self.OP_ID, attr_name, type(attr_val), attr_val)
          raise errors.OpPrereqError("Parameter '%s.%s' fails validation" %
                                     (self.OP_ID, attr_name),
                                     errors.ECODE_INVAL)

398

399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
def _BuildJobDepCheck(relative):
  """Builds check for job dependencies (L{DEPEND_ATTR}).

  @type relative: bool
  @param relative: Whether to accept relative job IDs (negative)
  @rtype: callable

  """
  if relative:
    job_id = ht.TOr(ht.TJobId, ht.TRelativeJobId)
  else:
    job_id = ht.TJobId

  job_dep = \
    ht.TAnd(ht.TIsLength(2),
            ht.TItems([job_id,
                       ht.TListOf(ht.TElemOf(constants.JOBS_FINALIZED))]))

  return ht.TOr(ht.TNone, ht.TListOf(job_dep))


TNoRelativeJobDependencies = _BuildJobDepCheck(False)

422
423
424
#: List of submission status and job ID as returned by C{SubmitManyJobs}
TJobIdList = ht.TListOf(ht.TItems([ht.TBool, ht.TOr(ht.TString, ht.TJobId)]))

425

Iustin Pop's avatar
Iustin Pop committed
426
class OpCode(BaseOpCode):
Iustin Pop's avatar
Iustin Pop committed
427
428
429
430
431
432
  """Abstract OpCode.

  This is the root of the actual OpCode hierarchy. All clases derived
  from this class should override OP_ID.

  @cvar OP_ID: The ID of this opcode. This should be unique amongst all
433
               children of this class.
434
435
436
  @cvar OP_DSC_FIELD: The name of a field whose value will be included in the
                      string returned by Summary(); see the docstring of that
                      method for details).
437
438
  @cvar OP_PARAMS: List of opcode attributes, the default values they should
                   get if not already defined, and types they must match.
439
  @cvar OP_RESULT: Callable to verify opcode result
440
441
  @cvar WITH_LU: Boolean that specifies whether this should be included in
      mcpu's dispatch table
442
443
  @ivar dry_run: Whether the LU should be run in dry-run mode, i.e. just
                 the check steps
444
  @ivar priority: Opcode priority for queue
Iustin Pop's avatar
Iustin Pop committed
445
446

  """
447
448
  # pylint: disable-msg=E1101
  # as OP_ID is dynamically defined
449
  WITH_LU = True
450
  OP_PARAMS = [
451
452
    ("dry_run", None, ht.TMaybeBool, "Run checks only, don't execute"),
    ("debug_level", None, ht.TOr(ht.TNone, ht.TPositiveInt), "Debug level"),
453
    ("priority", constants.OP_PRIO_DEFAULT,
454
     ht.TElemOf(constants.OP_PRIO_SUBMIT_VALID), "Opcode priority"),
455
456
457
    (DEPEND_ATTR, None, _BuildJobDepCheck(True),
     "Job dependencies; if used through ``SubmitManyJobs`` relative (negative)"
     " job IDs can be used"),
458
459
    (COMMENT_ATTR, None, ht.TMaybeString,
     "Comment describing the purpose of the opcode"),
460
    ]
461
  OP_RESULT = None
462
463
464
465

  def __getstate__(self):
    """Specialized getstate for opcodes.

Iustin Pop's avatar
Iustin Pop committed
466
467
468
469
470
471
472
    This method adds to the state dictionary the OP_ID of the class,
    so that on unload we can identify the correct class for
    instantiating the opcode.

    @rtype:   C{dict}
    @return:  the state as a dictionary

473
    """
Iustin Pop's avatar
Iustin Pop committed
474
    data = BaseOpCode.__getstate__(self)
475
476
477
478
    data["OP_ID"] = self.OP_ID
    return data

  @classmethod
479
  def LoadOpCode(cls, data):
480
481
    """Generic load opcode method.

Iustin Pop's avatar
Iustin Pop committed
482
483
484
485
486
487
488
    The method identifies the correct opcode class from the dict-form
    by looking for a OP_ID key, if this is not found, or its value is
    not available in this module as a child of this class, we fail.

    @type data:  C{dict}
    @param data: the serialized opcode

489
490
491
492
493
494
495
    """
    if not isinstance(data, dict):
      raise ValueError("Invalid data to LoadOpCode (%s)" % type(data))
    if "OP_ID" not in data:
      raise ValueError("Invalid data to LoadOpcode, missing OP_ID")
    op_id = data["OP_ID"]
    op_class = None
Iustin Pop's avatar
Iustin Pop committed
496
497
498
    if op_id in OP_MAPPING:
      op_class = OP_MAPPING[op_id]
    else:
499
500
501
502
503
504
505
506
      raise ValueError("Invalid data to LoadOpCode: OP_ID %s unsupported" %
                       op_id)
    op = op_class()
    new_data = data.copy()
    del new_data["OP_ID"]
    op.__setstate__(new_data)
    return op

507
508
509
  def Summary(self):
    """Generates a summary description of this opcode.

510
511
512
513
514
    The summary is the value of the OP_ID attribute (without the "OP_"
    prefix), plus the value of the OP_DSC_FIELD attribute, if one was
    defined; this field should allow to easily identify the operation
    (for an instance creation job, e.g., it would be the instance
    name).
515

516
    """
517
    assert self.OP_ID is not None and len(self.OP_ID) > 3
518
519
520
521
522
    # all OP_ID start with OP_, we remove that
    txt = self.OP_ID[3:]
    field_name = getattr(self, "OP_DSC_FIELD", None)
    if field_name:
      field_value = getattr(self, field_name, None)
523
524
      if isinstance(field_value, (list, tuple)):
        field_value = ",".join(str(i) for i in field_value)
525
526
527
      txt = "%s(%s)" % (txt, field_value)
    return txt

528
529
530
531
532
533
534
535
536
537
538
539
540
541
  def TinySummary(self):
    """Generates a compact summary description of the opcode.

    """
    assert self.OP_ID.startswith("OP_")

    text = self.OP_ID[3:]

    for (prefix, supplement) in _SUMMARY_PREFIX.items():
      if text.startswith(prefix):
        return supplement + text[len(prefix):]

    return text

Iustin Pop's avatar
Iustin Pop committed
542

543
544
# cluster opcodes

545
class OpClusterPostInit(OpCode):
546
547
548
549
550
551
552
553
  """Post cluster initialization.

  This opcode does not touch the cluster at all. Its purpose is to run hooks
  after the cluster has been initialized.

  """


554
class OpClusterDestroy(OpCode):
Iustin Pop's avatar
Iustin Pop committed
555
556
557
558
559
560
  """Destroy the cluster.

  This opcode has no other parameters. All the state is irreversibly
  lost after the execution of this opcode.

  """
Iustin Pop's avatar
Iustin Pop committed
561
562


563
class OpClusterQuery(OpCode):
Iustin Pop's avatar
Iustin Pop committed
564
  """Query cluster information."""
Iustin Pop's avatar
Iustin Pop committed
565
566


567
568
569
570
571
572
573
574
575
576
577
578
579
class OpClusterVerifyConfig(OpCode):
  """Verify the cluster config.

  """
  OP_PARAMS = [
    ("verbose", False, ht.TBool, None),
    ("error_codes", False, ht.TBool, None),
    ("debug_simulate_errors", False, ht.TBool, None),
    ]


class OpClusterVerifyGroup(OpCode):
  """Run verify on a node group from the cluster.
Iustin Pop's avatar
Iustin Pop committed
580
581
582
583
584
585
586
587

  @type skip_checks: C{list}
  @ivar skip_checks: steps to be skipped from the verify process; this
                     needs to be a subset of
                     L{constants.VERIFY_OPTIONAL_CHECKS}; currently
                     only L{constants.VERIFY_NPLUSONE_MEM} can be passed

  """
588
  OP_DSC_FIELD = "group_name"
589
  OP_PARAMS = [
590
    ("group_name", ht.NoDefault, ht.TNonEmptyString, None),
591
    ("skip_checks", ht.EmptyList,
592
593
594
595
     ht.TListOf(ht.TElemOf(constants.VERIFY_OPTIONAL_CHECKS)), None),
    ("verbose", False, ht.TBool, None),
    ("error_codes", False, ht.TBool, None),
    ("debug_simulate_errors", False, ht.TBool, None),
596
    ]
Iustin Pop's avatar
Iustin Pop committed
597
598


599
class OpClusterVerifyDisks(OpCode):
Iustin Pop's avatar
Iustin Pop committed
600
601
  """Verify the cluster disks.

602
  """
603
604
605
  OP_RESULT = ht.TStrictDict(True, True, {
    constants.JOB_IDS_KEY: TJobIdList,
    })
606
607
608
609


class OpGroupVerifyDisks(OpCode):
  """Verifies the status of all disks in a node group.
Iustin Pop's avatar
Iustin Pop committed
610

611
612
  Result: a tuple of three elements:
    - dict of node names with issues (values: error msg)
Iustin Pop's avatar
Iustin Pop committed
613
    - list of instances with degraded disks (that should be activated)
614
615
    - dict of instances with missing logical volumes (values: (node, vol)
      pairs with details about the missing volumes)
Iustin Pop's avatar
Iustin Pop committed
616

617
618
619
620
  In normal operation, all lists should be empty. A non-empty instance
  list (3rd element of the result) is still ok (errors were fixed) but
  non-empty node list means some node is down, and probably there are
  unfixable drbd errors.
Iustin Pop's avatar
Iustin Pop committed
621
622
623
624
625

  Note that only instances that are drbd-based are taken into
  consideration. This might need to be revisited in the future.

  """
626
627
628
629
  OP_DSC_FIELD = "group_name"
  OP_PARAMS = [
    _PGroupName,
    ]
630
631
632
633
634
  OP_RESULT = \
    ht.TAnd(ht.TIsLength(3),
            ht.TItems([ht.TDictOf(ht.TString, ht.TString),
                       ht.TListOf(ht.TString),
                       ht.TDictOf(ht.TString, ht.TListOf(ht.TString))]))
Iustin Pop's avatar
Iustin Pop committed
635
636


637
class OpClusterRepairDiskSizes(OpCode):
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
  """Verify the disk sizes of the instances and fixes configuration
  mimatches.

  Parameters: optional instances list, in case we want to restrict the
  checks to only a subset of the instances.

  Result: a list of tuples, (instance, disk, new-size) for changed
  configurations.

  In normal operation, the list should be empty.

  @type instances: list
  @ivar instances: the list of instances to check, or empty for all instances

  """
653
  OP_PARAMS = [
654
    ("instances", ht.EmptyList, ht.TListOf(ht.TNonEmptyString), None),
655
    ]
656
657


658
class OpClusterConfigQuery(OpCode):
659
  """Query cluster configuration values."""
660
661
662
  OP_PARAMS = [
    _POutputFields
    ]
Iustin Pop's avatar
Iustin Pop committed
663
664


665
class OpClusterRename(OpCode):
Iustin Pop's avatar
Iustin Pop committed
666
667
668
669
670
671
672
673
  """Rename the cluster.

  @type name: C{str}
  @ivar name: The new name of the cluster. The name and/or the master IP
              address will be changed to match the new name and its IP
              address.

  """
674
  OP_DSC_FIELD = "name"
675
  OP_PARAMS = [
676
    ("name", ht.NoDefault, ht.TNonEmptyString, None),
677
    ]
678
679


680
class OpClusterSetParams(OpCode):
Iustin Pop's avatar
Iustin Pop committed
681
682
683
684
685
686
  """Change the parameters of the cluster.

  @type vg_name: C{str} or C{None}
  @ivar vg_name: The new volume group name or None to disable LVM usage.

  """
687
  OP_PARAMS = [
688
    ("vg_name", None, ht.TMaybeString, "Volume group name"),
689
690
    ("enabled_hypervisors", None,
     ht.TOr(ht.TAnd(ht.TListOf(ht.TElemOf(constants.HYPER_TYPES)), ht.TTrue),
691
692
            ht.TNone),
     "List of enabled hypervisors"),
693
    ("hvparams", None, ht.TOr(ht.TDictOf(ht.TNonEmptyString, ht.TDict),
694
695
696
697
                              ht.TNone),
     "Cluster-wide hypervisor parameter defaults, hypervisor-dependent"),
    ("beparams", None, ht.TOr(ht.TDict, ht.TNone),
     "Cluster-wide backend parameter defaults"),
698
    ("os_hvp", None, ht.TOr(ht.TDictOf(ht.TNonEmptyString, ht.TDict),
699
700
                            ht.TNone),
     "Cluster-wide per-OS hypervisor parameter defaults"),
701
    ("osparams", None, ht.TOr(ht.TDictOf(ht.TNonEmptyString, ht.TDict),
702
703
                              ht.TNone),
     "Cluster-wide OS parameter defaults"),
704
    ("candidate_pool_size", None, ht.TOr(ht.TStrictPositiveInt, ht.TNone),
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
     "Master candidate pool size"),
    ("uid_pool", None, ht.NoType,
     "Set UID pool, must be list of lists describing UID ranges (two items,"
     " start and end inclusive)"),
    ("add_uids", None, ht.NoType,
     "Extend UID pool, must be list of lists describing UID ranges (two"
     " items, start and end inclusive) to be added"),
    ("remove_uids", None, ht.NoType,
     "Shrink UID pool, must be list of lists describing UID ranges (two"
     " items, start and end inclusive) to be removed"),
    ("maintain_node_health", None, ht.TMaybeBool,
     "Whether to automatically maintain node health"),
    ("prealloc_wipe_disks", None, ht.TMaybeBool,
     "Whether to wipe disks before allocating them to instances"),
    ("nicparams", None, ht.TMaybeDict, "Cluster-wide NIC parameter defaults"),
    ("ndparams", None, ht.TMaybeDict, "Cluster-wide node parameter defaults"),
    ("drbd_helper", None, ht.TOr(ht.TString, ht.TNone), "DRBD helper program"),
    ("default_iallocator", None, ht.TOr(ht.TString, ht.TNone),
     "Default iallocator for cluster"),
    ("master_netdev", None, ht.TOr(ht.TString, ht.TNone),
     "Master network device"),
    ("reserved_lvs", None, ht.TOr(ht.TListOf(ht.TNonEmptyString), ht.TNone),
     "List of reserved LVs"),
    ("hidden_os", None, _TestClusterOsList,
     "Modify list of hidden operating systems. Each modification must have"
     " two items, the operation and the OS name. The operation can be"
     " ``%s`` or ``%s``." % (constants.DDM_ADD, constants.DDM_REMOVE)),
    ("blacklisted_os", None, _TestClusterOsList,
     "Modify list of blacklisted operating systems. Each modification must have"
     " two items, the operation and the OS name. The operation can be"
     " ``%s`` or ``%s``." % (constants.DDM_ADD, constants.DDM_REMOVE)),
736
    ]
737
738


739
class OpClusterRedistConf(OpCode):
740
741
742
743
  """Force a full push of the cluster configuration.

  """

Michael Hanselmann's avatar
Michael Hanselmann committed
744
745
746
747

class OpQuery(OpCode):
  """Query for resources/items.

748
  @ivar what: Resources to query for, must be one of L{constants.QR_VIA_OP}
Michael Hanselmann's avatar
Michael Hanselmann committed
749
750
751
752
  @ivar fields: List of fields to retrieve
  @ivar filter: Query filter

  """
753
  OP_PARAMS = [
754
    _PQueryWhat,
755
756
    ("fields", ht.NoDefault, ht.TListOf(ht.TNonEmptyString),
     "Requested fields"),
757
    ("filter", None, ht.TOr(ht.TNone, ht.TListOf),
758
     "Query filter"),
Michael Hanselmann's avatar
Michael Hanselmann committed
759
760
761
762
763
764
    ]


class OpQueryFields(OpCode):
  """Query for available resource/item fields.

765
  @ivar what: Resources to query for, must be one of L{constants.QR_VIA_OP}
Michael Hanselmann's avatar
Michael Hanselmann committed
766
767
768
  @ivar fields: List of fields to retrieve

  """
769
  OP_PARAMS = [
770
771
772
    _PQueryWhat,
    ("fields", None, ht.TOr(ht.TNone, ht.TListOf(ht.TNonEmptyString)),
     "Requested fields; if not given, all are returned"),
Michael Hanselmann's avatar
Michael Hanselmann committed
773
774
775
    ]


776
class OpOobCommand(OpCode):
René Nussbaumer's avatar
René Nussbaumer committed
777
  """Interact with OOB."""
778
  OP_PARAMS = [
779
780
781
782
783
784
785
786
    ("node_names", ht.EmptyList, ht.TListOf(ht.TNonEmptyString),
     "List of nodes to run the OOB command against"),
    ("command", None, ht.TElemOf(constants.OOB_COMMANDS),
     "OOB command to be run"),
    ("timeout", constants.OOB_TIMEOUT, ht.TInt,
     "Timeout before the OOB helper will be terminated"),
    ("ignore_status", False, ht.TBool,
     "Ignores the node offline status for power off"),
787
788
    ("power_delay", constants.OOB_POWER_DELAY, ht.TPositiveFloat,
     "Time in seconds to wait between powering on nodes"),
René Nussbaumer's avatar
René Nussbaumer committed
789
790
791
    ]


792
793
# node opcodes

794
class OpNodeRemove(OpCode):
Iustin Pop's avatar
Iustin Pop committed
795
796
797
798
799
800
801
  """Remove a node.

  @type node_name: C{str}
  @ivar node_name: The name of the node to remove. If the node still has
                   instances on it, the operation will fail.

  """
802
  OP_DSC_FIELD = "node_name"
803
804
805
  OP_PARAMS = [
    _PNodeName,
    ]
Iustin Pop's avatar
Iustin Pop committed
806
807


Iustin Pop's avatar
Iustin Pop committed
808
class OpNodeAdd(OpCode):
Iustin Pop's avatar
Iustin Pop committed
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
  """Add a node to the cluster.

  @type node_name: C{str}
  @ivar node_name: The name of the node to add. This can be a short name,
                   but it will be expanded to the FQDN.
  @type primary_ip: IP address
  @ivar primary_ip: The primary IP of the node. This will be ignored when the
                    opcode is submitted, but will be filled during the node
                    add (so it will be visible in the job query).
  @type secondary_ip: IP address
  @ivar secondary_ip: The secondary IP of the node. This needs to be passed
                      if the cluster has been initialized in 'dual-network'
                      mode, otherwise it must not be given.
  @type readd: C{bool}
  @ivar readd: Whether to re-add an existing node to the cluster. If
               this is not passed, then the operation will abort if the node
               name is already in the cluster; use this parameter to 'repair'
               a node that had its configuration broken, or was reinstalled
               without removal from the cluster.
828
829
  @type group: C{str}
  @ivar group: The node group to which this node will belong.
830
831
832
833
  @type vm_capable: C{bool}
  @ivar vm_capable: The vm_capable node attribute
  @type master_capable: C{bool}
  @ivar master_capable: The master_capable node attribute
Iustin Pop's avatar
Iustin Pop committed
834
835

  """
836
  OP_DSC_FIELD = "node_name"
837
838
  OP_PARAMS = [
    _PNodeName,
839
840
841
842
843
844
845
846
847
    ("primary_ip", None, ht.NoType, "Primary IP address"),
    ("secondary_ip", None, ht.TMaybeString, "Secondary IP address"),
    ("readd", False, ht.TBool, "Whether node is re-added to cluster"),
    ("group", None, ht.TMaybeString, "Initial node group"),
    ("master_capable", None, ht.TMaybeBool,
     "Whether node can become master or master candidate"),
    ("vm_capable", None, ht.TMaybeBool,
     "Whether node can host instances"),
    ("ndparams", None, ht.TMaybeDict, "Node parameters"),
848
    ]
Iustin Pop's avatar
Iustin Pop committed
849
850


851
class OpNodeQuery(OpCode):
Iustin Pop's avatar
Iustin Pop committed
852
  """Compute the list of nodes."""
853
854
  OP_PARAMS = [
    _POutputFields,
855
856
857
    _PUseLocking,
    ("names", ht.EmptyList, ht.TListOf(ht.TNonEmptyString),
     "Empty list to query all nodes, node names otherwise"),
858
    ]
Iustin Pop's avatar
Iustin Pop committed
859
860


861
class OpNodeQueryvols(OpCode):
862
  """Get list of volumes on node."""
863
864
  OP_PARAMS = [
    _POutputFields,
865
866
    ("nodes", ht.EmptyList, ht.TListOf(ht.TNonEmptyString),
     "Empty list to query all nodes, node names otherwise"),
867
    ]
868
869


870
class OpNodeQueryStorage(OpCode):
871
  """Get information on storage for node(s)."""
872
873
874
  OP_PARAMS = [
    _POutputFields,
    _PStorageType,
875
876
    ("nodes", ht.EmptyList, ht.TListOf(ht.TNonEmptyString), "List of nodes"),
    ("name", None, ht.TMaybeString, "Storage name"),
877
878
879
    ]


880
class OpNodeModifyStorage(OpCode):
881
  """Modifies the properies of a storage unit"""
882
883
884
  OP_PARAMS = [
    _PNodeName,
    _PStorageType,
885
886
    _PStorageName,
    ("changes", ht.NoDefault, ht.TDict, "Requested changes"),
887
888
889
    ]


890
891
892
class OpRepairNodeStorage(OpCode):
  """Repairs the volume group on a node."""
  OP_DSC_FIELD = "node_name"
893
894
895
  OP_PARAMS = [
    _PNodeName,
    _PStorageType,
896
897
    _PStorageName,
    _PIgnoreConsistency,
898
899
900
    ]


901
class OpNodeSetParams(OpCode):
Iustin Pop's avatar
Iustin Pop committed
902
903
  """Change the parameters of a node."""
  OP_DSC_FIELD = "node_name"
904
905
906
  OP_PARAMS = [
    _PNodeName,
    _PForce,
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
    ("master_candidate", None, ht.TMaybeBool,
     "Whether the node should become a master candidate"),
    ("offline", None, ht.TMaybeBool,
     "Whether the node should be marked as offline"),
    ("drained", None, ht.TMaybeBool,
     "Whether the node should be marked as drained"),
    ("auto_promote", False, ht.TBool,
     "Whether node(s) should be promoted to master candidate if necessary"),
    ("master_capable", None, ht.TMaybeBool,
     "Denote whether node can become master or master candidate"),
    ("vm_capable", None, ht.TMaybeBool,
     "Denote whether node can host instances"),
    ("secondary_ip", None, ht.TMaybeString,
     "Change node's secondary IP address"),
    ("ndparams", None, ht.TMaybeDict, "Set node parameters"),
    ("powered", None, ht.TMaybeBool,
     "Whether the node should be marked as powered"),
Iustin Pop's avatar
Iustin Pop committed
924
925
    ]

Iustin Pop's avatar
Iustin Pop committed
926

927
class OpNodePowercycle(OpCode):
Iustin Pop's avatar
Iustin Pop committed
928
929
  """Tries to powercycle a node."""
  OP_DSC_FIELD = "node_name"
930
931
932
  OP_PARAMS = [
    _PNodeName,
    _PForce,
Iustin Pop's avatar
Iustin Pop committed
933
934
    ]

935

936
class OpNodeMigrate(OpCode):
937
938
  """Migrate all instances from a node."""
  OP_DSC_FIELD = "node_name"
939
940
941
942
  OP_PARAMS = [
    _PNodeName,
    _PMigrationMode,
    _PMigrationLive,
Michael Hanselmann's avatar
Michael Hanselmann committed
943
    _PMigrationTargetNode,
944
945
    ("iallocator", None, ht.TMaybeString,
     "Iallocator for deciding the target node for shared-storage instances"),
946
947
948
    ]


949
950
951
952
953
954
955
956
957
958
959
960
961
class OpNodeEvacuate(OpCode):
  """Evacuate instances off a number of nodes."""
  OP_DSC_FIELD = "node_name"
  OP_PARAMS = [
    _PEarlyRelease,
    _PNodeName,
    ("remote_node", None, ht.TMaybeString, "New secondary node"),
    ("iallocator", None, ht.TMaybeString, "Iallocator for computing solution"),
    ("mode", ht.NoDefault, ht.TElemOf(constants.IALLOCATOR_NEVAC_MODES),
     "Node evacuation mode"),
    ]


Iustin Pop's avatar
Iustin Pop committed
962
963
# instance opcodes

964
class OpInstanceCreate(OpCode):
965
966
967
968
969
970
971
  """Create an instance.

  @ivar instance_name: Instance name
  @ivar mode: Instance creation mode (one of L{constants.INSTANCE_CREATE_MODES})
  @ivar source_handshake: Signed handshake from source (remote import only)
  @ivar source_x509_ca: Source X509 CA in PEM format (remote import only)
  @ivar source_instance_name: Previous name of instance (remote import only)
972
973
  @ivar source_shutdown_timeout: Shutdown timeout used for source instance
    (remote import only)
974
975

  """
976
  OP_DSC_FIELD = "instance_name"
977
978
  OP_PARAMS = [
    _PInstanceName,
979
980
981
982
    _PForceVariant,
    _PWaitForSync,
    _PNameCheck,
    ("beparams", ht.EmptyDict, ht.TDict, "Backend parameters for instance"),
983
984
985
986
987
988
989
990
991
992
993
    ("disks", ht.NoDefault,
     # TODO: Generate check from constants.IDISK_PARAMS_TYPES
     ht.TListOf(ht.TDictOf(ht.TElemOf(constants.IDISK_PARAMS),
                           ht.TOr(ht.TNonEmptyString, ht.TInt))),
     "Disk descriptions, for example ``[{\"%s\": 100}, {\"%s\": 5}]``;"
     " each disk definition must contain a ``%s`` value and"
     " can contain an optional ``%s`` value denoting the disk access mode"
     " (%s)" %
     (constants.IDISK_SIZE, constants.IDISK_SIZE, constants.IDISK_SIZE,
      constants.IDISK_MODE,
      " or ".join("``%s``" % i for i in sorted(constants.DISK_ACCESS_SET)))),
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
    ("disk_template", ht.NoDefault, _CheckDiskTemplate, "Disk template"),
    ("file_driver", None, ht.TOr(ht.TNone, ht.TElemOf(constants.FILE_DRIVER)),
     "Driver for file-backed disks"),
    ("file_storage_dir", None, ht.TMaybeString,
     "Directory for storing file-backed disks"),
    ("hvparams", ht.EmptyDict, ht.TDict,
     "Hypervisor parameters for instance, hypervisor-dependent"),
    ("hypervisor", None, ht.TMaybeString, "Hypervisor"),
    ("iallocator", None, ht.TMaybeString,
     "Iallocator for deciding which node(s) to use"),
    ("identify_defaults", False, ht.TBool,
     "Reset instance parameters to default if equal"),
    ("ip_check", True, ht.TBool, _PIpCheckDoc),
    ("mode", ht.NoDefault, ht.TElemOf(constants.INSTANCE_CREATE_MODES),
     "Instance creation mode"),
1009
1010
1011
1012
1013
1014
    ("nics", ht.NoDefault, ht.TListOf(_TestNicDef),
     "List of NIC (network interface) definitions, for example"
     " ``[{}, {}, {\"%s\": \"198.51.100.4\"}]``; each NIC definition can"
     " contain the optional values %s" %
     (constants.INIC_IP,
      ", ".join("``%s``" % i for i in sorted(constants.INIC_PARAMS)))),
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
    ("no_install", None, ht.TMaybeBool,
     "Do not install the OS (will disable automatic start)"),
    ("osparams", ht.EmptyDict, ht.TDict, "OS parameters for instance"),
    ("os_type", None, ht.TMaybeString, "Operating system"),
    ("pnode", None, ht.TMaybeString, "Primary node"),
    ("snode", None, ht.TMaybeString, "Secondary node"),
    ("source_handshake", None, ht.TOr(ht.TList, ht.TNone),
     "Signed handshake from source (remote import only)"),
    ("source_instance_name", None, ht.TMaybeString,
     "Source instance name (remote import only)"),
1025
    ("source_shutdown_timeout", constants.DEFAULT_SHUTDOWN_TIMEOUT,
1026
1027
     ht.TPositiveInt,
     "How long source instance was given to shut down (remote import only)"),
1028
1029
1030
1031
1032
    ("source_x509_ca", None, ht.TMaybeString,
     "Source X509 CA in PEM format (remote import only)"),
    ("src_node", None, ht.TMaybeString, "Source node for import"),
    ("src_path", None, ht.TMaybeString, "Source directory for import"),
    ("start", True, ht.TBool, "Whether to start instance after creation"),
1033
    ("tags", ht.EmptyList, ht.TListOf(ht.TNonEmptyString), "Instance tags"),
1034
    ]
Iustin Pop's avatar
Iustin Pop committed
1035
1036


1037
class OpInstanceReinstall(OpCode):
Iustin Pop's avatar
Iustin Pop committed
1038
  """Reinstall an instance's OS."""
1039
  OP_DSC_FIELD = "instance_name"
1040
1041
  OP_PARAMS = [
    _PInstanceName,
1042
1043
1044
    _PForceVariant,
    ("os_type", None, ht.TMaybeString, "Instance operating system"),
    ("osparams", None, ht.TMaybeDict, "Temporary OS parameters"),
1045
    ]
1046
1047


1048
class OpInstanceRemove(OpCode):
Iustin Pop's avatar
Iustin Pop committed
1049
  """Remove an instance."""
1050
  OP_DSC_FIELD = "instance_name"
1051
1052
1053
  OP_PARAMS = [
    _PInstanceName,
    _PShutdownTimeout,
1054
1055
    ("ignore_failures", False, ht.TBool,
     "Whether to ignore failures during removal"),
1056
    ]
Iustin Pop's avatar
Iustin Pop committed
1057
1058


1059
class OpInstanceRename(OpCode):
1060
  """Rename an instance."""
1061
1062
  OP_PARAMS = [
    _PInstanceName,
1063
1064
1065
    _PNameCheck,
    ("new_name", ht.NoDefault, ht.TNonEmptyString, "New instance name"),
    ("ip_check", False, ht.TBool, _PIpCheckDoc),
1066
    ]
1067
1068


1069
class OpInstanceStartup(OpCode):
Iustin Pop's avatar
Iustin Pop committed
1070
  """Startup an instance."""
1071
  OP_DSC_FIELD = "instance_name"
1072
1073
1074
1075
  OP_PARAMS = [
    _PInstanceName,
    _PForce,
    _PIgnoreOfflineNodes,
1076
1077
1078
    ("hvparams", ht.EmptyDict, ht.TDict,
     "Temporary hypervisor parameters, hypervisor-dependent"),
    ("beparams", ht.EmptyDict, ht.TDict, "Temporary backend parameters"),
1079
    _PNoRemember,
1080
    _PStartupPaused,
1081
    ]
Iustin Pop's avatar
Iustin Pop committed
1082
1083


1084
class OpInstanceShutdown(OpCode):
Iustin Pop's avatar
Iustin Pop committed
1085
  """Shutdown an instance."""
1086
  OP_DSC_FIELD = "instance_name"
1087
1088
1089
  OP_PARAMS = [
    _PInstanceName,
    _PIgnoreOfflineNodes,
1090
1091
    ("timeout", constants.DEFAULT_SHUTDOWN_TIMEOUT, ht.TPositiveInt,
     "How long to wait for instance to shut down"),
1092
    _PNoRemember,
1093
    ]
Iustin Pop's avatar
Iustin Pop committed
1094
1095


1096
class OpInstanceReboot(OpCode):
1097
  """Reboot an instance."""
1098
  OP_DSC_FIELD = "instance_name"
1099
1100
1101
  OP_PARAMS = [
    _PInstanceName,
    _PShutdownTimeout,
1102
1103
1104
1105
    ("ignore_secondaries", False, ht.TBool,
     "Whether to start the instance even if secondary disks are failing"),
    ("reboot_type", ht.NoDefault, ht.TElemOf(constants.REBOOT_TYPES),
     "How to reboot instance"),
1106
    ]
1107
1108


1109
class OpInstanceReplaceDisks(OpCode):
Iustin Pop's avatar
Iustin Pop committed
1110
  """Replace the disks of an instance."""
1111
  OP_DSC_FIELD = "instance_name"
1112
1113
  OP_PARAMS = [
    _PInstanceName,
1114
    _PEarlyRelease,
1115
1116
1117
1118
1119
1120
1121
    ("mode", ht.NoDefault, ht.TElemOf(constants.REPLACE_MODES),
     "Replacement mode"),
    ("disks", ht.EmptyList, ht.TListOf(ht.TPositiveInt),
     "Disk indexes"),
    ("remote_node", None, ht.TMaybeString, "New secondary node"),
    ("iallocator", None, ht.TMaybeString,
     "Iallocator for deciding new secondary node"),
1122
    ]
Iustin Pop's avatar
Iustin Pop committed
1123
1124


1125
class OpInstanceFailover(OpCode):
Iustin Pop's avatar
Iustin Pop committed
1126
  """Failover an instance."""
1127
  OP_DSC_FIELD = "instance_name"
1128
1129
1130
  OP_PARAMS = [
    _PInstanceName,
    _PShutdownTimeout,
1131
    _PIgnoreConsistency,
Michael Hanselmann's avatar
Michael Hanselmann committed
1132
    _PMigrationTargetNode,
1133
1134
    ("iallocator", None, ht.TMaybeString,
     "Iallocator for deciding the target node for shared-storage instances"),
1135
    ]
Iustin Pop's avatar
Iustin Pop committed
1136
1137


1138
class OpInstanceMigrate(OpCode):
1139
1140
1141
1142
1143
  """Migrate an instance.

  This migrates (without shutting down an instance) to its secondary
  node.

Iustin Pop's avatar
Iustin Pop committed
1144
  @ivar instance_name: the name of the instance
1145
  @ivar mode: the migration mode (live, non-live or None for auto)
1146
1147

  """
Iustin Pop's avatar
Iustin Pop committed
1148
  OP_DSC_FIELD = "instance_name"
1149
1150
1151
1152
  OP_PARAMS = [
    _PInstanceName,
    _PMigrationMode,
    _PMigrationLive,
Michael Hanselmann's avatar
Michael Hanselmann committed
1153
    _PMigrationTargetNode,
1154
1155
    ("cleanup", False, ht.TBool,
     "Whether a previously failed migration should be cleaned up"),
1156
1157
    ("iallocator", None, ht.TMaybeString,
     "Iallocator for deciding the target node for shared-storage instances"),
1158
1159
    ("allow_failover", False, ht.TBool,
     "Whether we can fallback to failover if migration is not possible"),
1160
    ]
1161
1162


1163
class OpInstanceMove(OpCode):
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
  """Move an instance.

  This move (with shutting down an instance and data copying) to an
  arbitrary node.

  @ivar instance_name: the name of the instance
  @ivar target_node: the destination node

  """
  OP_DSC_FIELD = "instance_name"
1174
1175
1176
  OP_PARAMS = [
    _PInstanceName,
    _PShutdownTimeout,
1177
    ("target_node", ht.NoDefault, ht.TNonEmptyString, "Target node"),
Iustin Pop's avatar
Iustin Pop committed
1178
    _PIgnoreConsistency,
Balazs Lecz's avatar
Balazs Lecz committed
1179
    ]
1180
1181


1182
class OpInstanceConsole(OpCode):
Iustin Pop's avatar
Iustin Pop committed
1183
  """Connect to an instance's console."""
1184
  OP_DSC_FIELD = "instance_name"
1185
1186
1187
  OP_PARAMS = [
    _PInstanceName
    ]
Iustin Pop's avatar
Iustin Pop committed
1188
1189


1190
class OpInstanceActivateDisks(OpCode):
Iustin Pop's avatar
Iustin Pop committed
1191
  """Activate an instance's disks."""
1192
  OP_DSC_FIELD = "instance_name"
1193
1194
  OP_PARAMS