opcodes.py 46.2 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
_PIpCheckDoc = "Whether to ensure instance's IP address is inactive"

117
#: Do not remember instance state changes
118
119
_PNoRemember = ("no_remember", False, ht.TBool,
                "Do not remember the state change")
120

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

125
126
127
#: OP_ID conversion regular expression
_OPID_RE = re.compile("([a-z])([A-Z])")

128
129
130
131
132
133
#: 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)))))

134

135
136
137
138
139
# 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))

140
141
142
143
144
145
146
_SUMMARY_PREFIX = {
  "CLUSTER_": "C_",
  "GROUP_": "G_",
  "NODE_": "N_",
  "INSTANCE_": "I_",
  }

147

148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
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)

168
169
170
171
172
173
174
175
176
177
178
179
180
181
182

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)


183
184
185
186
187
188
189
190
191
192
193
194
195
196
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)


197
198
199
@ht.WithDesc("CheckFileStorage")
def _CheckFileStorage(value):
  """Ensures file storage is enabled if used.
200
201

  """
202
  if value == constants.DT_FILE:
203
    RequireFileStorage()
204
205
  elif value == constants.DT_SHARED_FILE:
    RequireSharedFileStorage()
206
207
208
  return True


209
210
211
212
_CheckDiskTemplate = ht.TAnd(ht.TElemOf(constants.DISK_TEMPLATES),
                             _CheckFileStorage)


213
214
215
216
217
218
219
220
221
222
223
224
225
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
226
227
_PStorageType = ("storage_type", ht.NoDefault, _CheckStorageType,
                 "Storage type")
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245


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
246
    assert "OP_ID" not in attrs, "Class '%s' defining OP_ID" % name
247

248
    attrs["OP_ID"] = _NameToId(name)
249
250
251
252
253

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

    # Use parameter names as slots
254
    slots = [pname for (pname, _, _, _) in params]
255
256
257
258
259
260
261
262

    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)

263

Iustin Pop's avatar
Iustin Pop committed
264
class BaseOpCode(object):
265
266
  """A simple serializable object.

Iustin Pop's avatar
Iustin Pop committed
267
268
269
  This object serves as a parent class for OpCode without any custom
  field handling.

270
  """
271
272
  # pylint: disable-msg=E1101
  # as OP_ID is dynamically defined
273
274
  __metaclass__ = _AutoOpParamSlots

Iustin Pop's avatar
Iustin Pop committed
275
  def __init__(self, **kwargs):
Iustin Pop's avatar
Iustin Pop committed
276
277
278
279
280
281
282
283
    """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.

    """
284
    slots = self._all_slots()
Iustin Pop's avatar
Iustin Pop committed
285
    for key in kwargs:
286
      if key not in slots:
287
        raise TypeError("Object %s doesn't support the parameter '%s'" %
288
                        (self.__class__.__name__, key))
Iustin Pop's avatar
Iustin Pop committed
289
290
      setattr(self, key, kwargs[key])

291
  def __getstate__(self):
Iustin Pop's avatar
Iustin Pop committed
292
293
294
295
296
297
298
299
300
    """Generic serializer.

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

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

    """
301
    state = {}
302
    for name in self._all_slots():
303
304
305
306
307
      if hasattr(self, name):
        state[name] = getattr(self, name)
    return state

  def __setstate__(self, state):
Iustin Pop's avatar
Iustin Pop committed
308
309
310
311
312
313
314
315
316
    """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}

    """
317
318
319
320
    if not isinstance(state, dict):
      raise ValueError("Invalid data to __setstate__: expected dict, got %s" %
                       type(state))

321
    for name in self._all_slots():
Iustin Pop's avatar
Iustin Pop committed
322
      if name not in state and hasattr(self, name):
323
324
325
326
327
        delattr(self, name)

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

328
329
330
331
332
333
334
335
336
337
  @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

338
339
340
341
342
343
344
345
346
347
  @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

348
349
350
351
352
353
354
355
356
  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

    """
357
    for (attr_name, default, test, _) in self.GetAllParams():
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
      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)

385

Iustin Pop's avatar
Iustin Pop committed
386
class OpCode(BaseOpCode):
Iustin Pop's avatar
Iustin Pop committed
387
388
389
390
391
392
  """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
393
               children of this class.
394
395
396
  @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).
397
398
  @cvar OP_PARAMS: List of opcode attributes, the default values they should
                   get if not already defined, and types they must match.
399
400
  @cvar WITH_LU: Boolean that specifies whether this should be included in
      mcpu's dispatch table
401
402
  @ivar dry_run: Whether the LU should be run in dry-run mode, i.e. just
                 the check steps
403
  @ivar priority: Opcode priority for queue
Iustin Pop's avatar
Iustin Pop committed
404
405

  """
406
407
  # pylint: disable-msg=E1101
  # as OP_ID is dynamically defined
408
  WITH_LU = True
409
  OP_PARAMS = [
410
411
    ("dry_run", None, ht.TMaybeBool, "Run checks only, don't execute"),
    ("debug_level", None, ht.TOr(ht.TNone, ht.TPositiveInt), "Debug level"),
412
    ("priority", constants.OP_PRIO_DEFAULT,
413
     ht.TElemOf(constants.OP_PRIO_SUBMIT_VALID), "Opcode priority"),
414
    ]
415
416
417
418

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

Iustin Pop's avatar
Iustin Pop committed
419
420
421
422
423
424
425
    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

426
    """
Iustin Pop's avatar
Iustin Pop committed
427
    data = BaseOpCode.__getstate__(self)
428
429
430
431
    data["OP_ID"] = self.OP_ID
    return data

  @classmethod
432
  def LoadOpCode(cls, data):
433
434
    """Generic load opcode method.

Iustin Pop's avatar
Iustin Pop committed
435
436
437
438
439
440
441
    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

442
443
444
445
446
447
448
    """
    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
449
450
451
    if op_id in OP_MAPPING:
      op_class = OP_MAPPING[op_id]
    else:
452
453
454
455
456
457
458
459
      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

460
461
462
  def Summary(self):
    """Generates a summary description of this opcode.

463
464
465
466
467
    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).
468

469
    """
470
    assert self.OP_ID is not None and len(self.OP_ID) > 3
471
472
473
474
475
    # 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)
476
477
      if isinstance(field_value, (list, tuple)):
        field_value = ",".join(str(i) for i in field_value)
478
479
480
      txt = "%s(%s)" % (txt, field_value)
    return txt

481
482
483
484
485
486
487
488
489
490
491
492
493
494
  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
495

496
497
# cluster opcodes

498
class OpClusterPostInit(OpCode):
499
500
501
502
503
504
505
506
  """Post cluster initialization.

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

  """


507
class OpClusterDestroy(OpCode):
Iustin Pop's avatar
Iustin Pop committed
508
509
510
511
512
513
  """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
514
515


516
class OpClusterQuery(OpCode):
Iustin Pop's avatar
Iustin Pop committed
517
  """Query cluster information."""
Iustin Pop's avatar
Iustin Pop committed
518
519


520
521
522
523
524
525
526
527
528
529
530
531
532
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
533
534
535
536
537
538
539
540

  @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

  """
541
  OP_DSC_FIELD = "group_name"
542
  OP_PARAMS = [
543
    ("group_name", ht.NoDefault, ht.TNonEmptyString, None),
544
    ("skip_checks", ht.EmptyList,
545
546
547
548
     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),
549
    ]
Iustin Pop's avatar
Iustin Pop committed
550
551


552
class OpClusterVerifyDisks(OpCode):
Iustin Pop's avatar
Iustin Pop committed
553
554
555
556
  """Verify the cluster disks.

  Parameters: none

557
  Result: a tuple of four elements:
Iustin Pop's avatar
Iustin Pop committed
558
    - list of node names with bad data returned (unreachable, etc.)
Iustin Pop's avatar
Iustin Pop committed
559
    - dict of node names with broken volume groups (values: error msg)
Iustin Pop's avatar
Iustin Pop committed
560
    - list of instances with degraded disks (that should be activated)
561
562
    - dict of instances with missing logical volumes (values: (node, vol)
      pairs with details about the missing volumes)
Iustin Pop's avatar
Iustin Pop committed
563

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

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

  """


575
class OpClusterRepairDiskSizes(OpCode):
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
  """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

  """
591
  OP_PARAMS = [
592
    ("instances", ht.EmptyList, ht.TListOf(ht.TNonEmptyString), None),
593
    ]
594
595


596
class OpClusterConfigQuery(OpCode):
597
  """Query cluster configuration values."""
598
599
600
  OP_PARAMS = [
    _POutputFields
    ]
Iustin Pop's avatar
Iustin Pop committed
601
602


603
class OpClusterRename(OpCode):
Iustin Pop's avatar
Iustin Pop committed
604
605
606
607
608
609
610
611
  """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.

  """
612
  OP_DSC_FIELD = "name"
613
  OP_PARAMS = [
614
    ("name", ht.NoDefault, ht.TNonEmptyString, None),
615
    ]
616
617


618
class OpClusterSetParams(OpCode):
Iustin Pop's avatar
Iustin Pop committed
619
620
621
622
623
624
  """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.

  """
625
  OP_PARAMS = [
626
    ("vg_name", None, ht.TMaybeString, "Volume group name"),
627
628
    ("enabled_hypervisors", None,
     ht.TOr(ht.TAnd(ht.TListOf(ht.TElemOf(constants.HYPER_TYPES)), ht.TTrue),
629
630
            ht.TNone),
     "List of enabled hypervisors"),
631
    ("hvparams", None, ht.TOr(ht.TDictOf(ht.TNonEmptyString, ht.TDict),
632
633
634
635
                              ht.TNone),
     "Cluster-wide hypervisor parameter defaults, hypervisor-dependent"),
    ("beparams", None, ht.TOr(ht.TDict, ht.TNone),
     "Cluster-wide backend parameter defaults"),
636
    ("os_hvp", None, ht.TOr(ht.TDictOf(ht.TNonEmptyString, ht.TDict),
637
638
                            ht.TNone),
     "Cluster-wide per-OS hypervisor parameter defaults"),
639
    ("osparams", None, ht.TOr(ht.TDictOf(ht.TNonEmptyString, ht.TDict),
640
641
                              ht.TNone),
     "Cluster-wide OS parameter defaults"),
642
    ("candidate_pool_size", None, ht.TOr(ht.TStrictPositiveInt, ht.TNone),
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
     "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)),
674
    ]
675
676


677
class OpClusterRedistConf(OpCode):
678
679
680
681
  """Force a full push of the cluster configuration.

  """

Michael Hanselmann's avatar
Michael Hanselmann committed
682
683
684
685

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

686
  @ivar what: Resources to query for, must be one of L{constants.QR_VIA_OP}
Michael Hanselmann's avatar
Michael Hanselmann committed
687
688
689
690
  @ivar fields: List of fields to retrieve
  @ivar filter: Query filter

  """
691
  OP_PARAMS = [
692
    _PQueryWhat,
693
694
    ("fields", ht.NoDefault, ht.TListOf(ht.TNonEmptyString),
     "Requested fields"),
695
    ("filter", None, ht.TOr(ht.TNone, ht.TListOf),
696
     "Query filter"),
Michael Hanselmann's avatar
Michael Hanselmann committed
697
698
699
700
701
702
    ]


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

703
  @ivar what: Resources to query for, must be one of L{constants.QR_VIA_OP}
Michael Hanselmann's avatar
Michael Hanselmann committed
704
705
706
  @ivar fields: List of fields to retrieve

  """
707
  OP_PARAMS = [
708
709
710
    _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
711
712
713
    ]


714
class OpOobCommand(OpCode):
René Nussbaumer's avatar
René Nussbaumer committed
715
  """Interact with OOB."""
716
  OP_PARAMS = [
717
718
719
720
721
722
723
724
    ("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"),
725
726
    ("power_delay", constants.OOB_POWER_DELAY, ht.TPositiveFloat,
     "Time in seconds to wait between powering on nodes"),
René Nussbaumer's avatar
René Nussbaumer committed
727
728
729
    ]


730
731
# node opcodes

732
class OpNodeRemove(OpCode):
Iustin Pop's avatar
Iustin Pop committed
733
734
735
736
737
738
739
  """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.

  """
740
  OP_DSC_FIELD = "node_name"
741
742
743
  OP_PARAMS = [
    _PNodeName,
    ]
Iustin Pop's avatar
Iustin Pop committed
744
745


Iustin Pop's avatar
Iustin Pop committed
746
class OpNodeAdd(OpCode):
Iustin Pop's avatar
Iustin Pop committed
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
  """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.
766
767
  @type group: C{str}
  @ivar group: The node group to which this node will belong.
768
769
770
771
  @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
772
773

  """
774
  OP_DSC_FIELD = "node_name"
775
776
  OP_PARAMS = [
    _PNodeName,
777
778
779
780
781
782
783
784
785
    ("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"),
786
    ]
Iustin Pop's avatar
Iustin Pop committed
787
788


789
class OpNodeQuery(OpCode):
Iustin Pop's avatar
Iustin Pop committed
790
  """Compute the list of nodes."""
791
792
  OP_PARAMS = [
    _POutputFields,
793
794
795
    _PUseLocking,
    ("names", ht.EmptyList, ht.TListOf(ht.TNonEmptyString),
     "Empty list to query all nodes, node names otherwise"),
796
    ]
Iustin Pop's avatar
Iustin Pop committed
797
798


799
class OpNodeQueryvols(OpCode):
800
  """Get list of volumes on node."""
801
802
  OP_PARAMS = [
    _POutputFields,
803
804
    ("nodes", ht.EmptyList, ht.TListOf(ht.TNonEmptyString),
     "Empty list to query all nodes, node names otherwise"),
805
    ]
806
807


808
class OpNodeQueryStorage(OpCode):
809
  """Get information on storage for node(s)."""
810
811
812
  OP_PARAMS = [
    _POutputFields,
    _PStorageType,
813
814
    ("nodes", ht.EmptyList, ht.TListOf(ht.TNonEmptyString), "List of nodes"),
    ("name", None, ht.TMaybeString, "Storage name"),
815
816
817
    ]


818
class OpNodeModifyStorage(OpCode):
819
  """Modifies the properies of a storage unit"""
820
821
822
  OP_PARAMS = [
    _PNodeName,
    _PStorageType,
823
824
    _PStorageName,
    ("changes", ht.NoDefault, ht.TDict, "Requested changes"),
825
826
827
    ]


828
829
830
class OpRepairNodeStorage(OpCode):
  """Repairs the volume group on a node."""
  OP_DSC_FIELD = "node_name"
831
832
833
  OP_PARAMS = [
    _PNodeName,
    _PStorageType,
834
835
    _PStorageName,
    _PIgnoreConsistency,
836
837
838
    ]


839
class OpNodeSetParams(OpCode):
Iustin Pop's avatar
Iustin Pop committed
840
841
  """Change the parameters of a node."""
  OP_DSC_FIELD = "node_name"
842
843
844
  OP_PARAMS = [
    _PNodeName,
    _PForce,
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
    ("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
862
863
    ]

Iustin Pop's avatar
Iustin Pop committed
864

865
class OpNodePowercycle(OpCode):
Iustin Pop's avatar
Iustin Pop committed
866
867
  """Tries to powercycle a node."""
  OP_DSC_FIELD = "node_name"
868
869
870
  OP_PARAMS = [
    _PNodeName,
    _PForce,
Iustin Pop's avatar
Iustin Pop committed
871
872
    ]

873

874
class OpNodeMigrate(OpCode):
875
876
  """Migrate all instances from a node."""
  OP_DSC_FIELD = "node_name"
877
878
879
880
  OP_PARAMS = [
    _PNodeName,
    _PMigrationMode,
    _PMigrationLive,
Michael Hanselmann's avatar
Michael Hanselmann committed
881
    _PMigrationTargetNode,
882
883
    ("iallocator", None, ht.TMaybeString,
     "Iallocator for deciding the target node for shared-storage instances"),
884
885
886
    ]


887
class OpNodeEvacStrategy(OpCode):
888
889
  """Compute the evacuation strategy for a list of nodes."""
  OP_DSC_FIELD = "nodes"
890
  OP_PARAMS = [
891
892
893
    ("nodes", ht.NoDefault, ht.TListOf(ht.TNonEmptyString), None),
    ("remote_node", None, ht.TMaybeString, None),
    ("iallocator", None, ht.TMaybeString, None),
894
    ]
895
896


Iustin Pop's avatar
Iustin Pop committed
897
898
# instance opcodes

899
class OpInstanceCreate(OpCode):
900
901
902
903
904
905
906
  """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)
907
908
  @ivar source_shutdown_timeout: Shutdown timeout used for source instance
    (remote import only)
909
910

  """
911
  OP_DSC_FIELD = "instance_name"
912
913
  OP_PARAMS = [
    _PInstanceName,
914
915
916
917
    _PForceVariant,
    _PWaitForSync,
    _PNameCheck,
    ("beparams", ht.EmptyDict, ht.TDict, "Backend parameters for instance"),
918
919
920
921
922
923
924
925
926
927
928
    ("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)))),
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
    ("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"),
944
945
946
947
948
949
    ("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)))),
950
951
952
953
954
955
956
957
958
959
    ("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)"),
960
    ("source_shutdown_timeout", constants.DEFAULT_SHUTDOWN_TIMEOUT,
961
962
     ht.TPositiveInt,
     "How long source instance was given to shut down (remote import only)"),
963
964
965
966
967
    ("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"),
968
    ]
Iustin Pop's avatar
Iustin Pop committed
969
970


971
class OpInstanceReinstall(OpCode):
Iustin Pop's avatar
Iustin Pop committed
972
  """Reinstall an instance's OS."""
973
  OP_DSC_FIELD = "instance_name"
974
975
  OP_PARAMS = [
    _PInstanceName,
976
977
978
    _PForceVariant,
    ("os_type", None, ht.TMaybeString, "Instance operating system"),
    ("osparams", None, ht.TMaybeDict, "Temporary OS parameters"),
979
    ]
980
981


982
class OpInstanceRemove(OpCode):
Iustin Pop's avatar
Iustin Pop committed
983
  """Remove an instance."""
984
  OP_DSC_FIELD = "instance_name"
985
986
987
  OP_PARAMS = [
    _PInstanceName,
    _PShutdownTimeout,
988
989
    ("ignore_failures", False, ht.TBool,
     "Whether to ignore failures during removal"),
990
    ]
Iustin Pop's avatar
Iustin Pop committed
991
992


993
class OpInstanceRename(OpCode):
994
  """Rename an instance."""
995
996
  OP_PARAMS = [
    _PInstanceName,
997
998
999
    _PNameCheck,
    ("new_name", ht.NoDefault, ht.TNonEmptyString, "New instance name"),
    ("ip_check", False, ht.TBool, _PIpCheckDoc),
1000
    ]
1001
1002


1003
class OpInstanceStartup(OpCode):
Iustin Pop's avatar
Iustin Pop committed
1004
  """Startup an instance."""
1005
  OP_DSC_FIELD = "instance_name"
1006
1007
1008
1009
  OP_PARAMS = [
    _PInstanceName,
    _PForce,
    _PIgnoreOfflineNodes,
1010
1011
1012
    ("hvparams", ht.EmptyDict, ht.TDict,
     "Temporary hypervisor parameters, hypervisor-dependent"),
    ("beparams", ht.EmptyDict, ht.TDict, "Temporary backend parameters"),
1013
    _PNoRemember,
1014
    ]
Iustin Pop's avatar
Iustin Pop committed
1015
1016


1017
class OpInstanceShutdown(OpCode):
Iustin Pop's avatar
Iustin Pop committed
1018
  """Shutdown an instance."""
1019
  OP_DSC_FIELD = "instance_name"
1020
1021
1022
  OP_PARAMS = [
    _PInstanceName,
    _PIgnoreOfflineNodes,
1023
1024
    ("timeout", constants.DEFAULT_SHUTDOWN_TIMEOUT, ht.TPositiveInt,
     "How long to wait for instance to shut down"),
1025
    _PNoRemember,
1026
    ]
Iustin Pop's avatar
Iustin Pop committed
1027
1028


1029
class OpInstanceReboot(OpCode):
1030
  """Reboot an instance."""
1031
  OP_DSC_FIELD = "instance_name"
1032
1033
1034
  OP_PARAMS = [
    _PInstanceName,
    _PShutdownTimeout,
1035
1036
1037
1038
    ("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"),
1039
    ]
1040
1041


1042
class OpInstanceReplaceDisks(OpCode):
Iustin Pop's avatar
Iustin Pop committed
1043
  """Replace the disks of an instance."""
1044
  OP_DSC_FIELD = "instance_name"
1045
1046
  OP_PARAMS = [
    _PInstanceName,
1047
1048
1049
1050
1051
1052
1053
1054
1055
    ("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"),
    ("early_release", False, ht.TBool,
     "Whether to release locks as soon as possible"),
1056
    ]
Iustin Pop's avatar
Iustin Pop committed
1057
1058


1059
class OpInstanceFailover(OpCode):
Iustin Pop's avatar
Iustin Pop committed
1060
  """Failover an instance."""
1061
  OP_DSC_FIELD = "instance_name"
1062
1063
1064
  OP_PARAMS = [
    _PInstanceName,
    _PShutdownTimeout,
1065
    _PIgnoreConsistency,
Michael Hanselmann's avatar
Michael Hanselmann committed
1066
    _PMigrationTargetNode,
1067
1068
    ("iallocator", None, ht.TMaybeString,
     "Iallocator for deciding the target node for shared-storage instances"),
1069
    ]
Iustin Pop's avatar
Iustin Pop committed
1070
1071


1072
class OpInstanceMigrate(OpCode):
1073
1074
1075
1076
1077
  """Migrate an instance.

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

Iustin Pop's avatar
Iustin Pop committed
1078
  @ivar instance_name: the name of the instance
1079
  @ivar mode: the migration mode (live, non-live or None for auto)
1080
1081

  """
Iustin Pop's avatar
Iustin Pop committed
1082
  OP_DSC_FIELD = "instance_name"
1083
1084
1085
1086
  OP_PARAMS = [
    _PInstanceName,
    _PMigrationMode,
    _PMigrationLive,
Michael Hanselmann's avatar
Michael Hanselmann committed
1087
    _PMigrationTargetNode,
1088
1089
    ("cleanup", False, ht.TBool,
     "Whether a previously failed migration should be cleaned up"),
1090
1091
    ("iallocator", None, ht.TMaybeString,
     "Iallocator for deciding the target node for shared-storage instances"),
1092
1093
    ("allow_failover", False, ht.TBool,
     "Whether we can fallback to failover if migration is not possible"),
1094
    ]
1095
1096


1097
class OpInstanceMove(OpCode):
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
  """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"
1108
1109
1110
  OP_PARAMS = [
    _PInstanceName,
    _PShutdownTimeout,
1111
    ("target_node", ht.NoDefault, ht.TNonEmptyString, "Target node"),
Iustin Pop's avatar
Iustin Pop committed
1112
    _PIgnoreConsistency,
Balazs Lecz's avatar
Balazs Lecz committed
1113
    ]
1114
1115


1116
class OpInstanceConsole(OpCode):
Iustin Pop's avatar
Iustin Pop committed
1117
  """Connect to an instance's console."""
1118
  OP_DSC_FIELD = "instance_name"
1119
1120
1121
  OP_PARAMS = [
    _PInstanceName
    ]
Iustin Pop's avatar
Iustin Pop committed
1122
1123


1124
class OpInstanceActivateDisks(OpCode):
Iustin Pop's avatar
Iustin Pop committed
1125
  """Activate an instance's disks."""
1126
  OP_DSC_FIELD = "instance_name"
1127
1128
  OP_PARAMS = [
    _PInstanceName,
1129
    ("ignore_size", False, ht.TBool, "Whether to ignore recorded size"),
1130
    ]
Iustin Pop's avatar
Iustin Pop committed
1131
1132


1133
class OpInstanceDeactivateDisks(OpCode):
Iustin Pop's avatar
Iustin Pop committed
1134
  """Deactivate an instance's disks."""
1135
  OP_DSC_FIELD = "instance_name"
1136
  OP_PARAMS = [
1137
1138
    _PInstanceName,
    _PForce,
1139
    ]
Iustin Pop's avatar
Iustin Pop committed
1140
1141


1142
class OpInstanceRecreateDisks(OpCode):
Iustin Pop's avatar
Iustin Pop committed
1143
1144
  """Deactivate an instance's disks."""
  OP_DSC_FIELD = "instance_name"
1145
1146
  OP_PARAMS = [
    _PInstanceName,
1147
1148
    ("disks", ht.EmptyList, ht.TListOf(ht.TPositiveInt),
     "List of disk indexes"),
Guido Trotter's avatar
Guido Trotter committed
1149
1150
    ("nodes", ht.EmptyList, ht.TListOf(ht.TNonEmptyString),
     "New instance nodes, if relocation is desired"),
1151
    ]
Iustin Pop's avatar
Iustin Pop committed
1152
1153


1154
class OpInstanceQuery(OpCode):
Iustin Pop's avatar
Iustin Pop committed
1155
  """Compute the list of instances."""
1156
1157
  OP_PARAMS = [
    _POutputFields,
1158
1159
1160
    _PUseLocking,
    ("names", ht.EmptyList, ht.TListOf(ht.TNonEmptyString),
     "Empty list to query all instances, instance names otherwise"),
1161
    ]