opcodes.py 43.1 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
112
113
_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")

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

114
115
116
#: OP_ID conversion regular expression
_OPID_RE = re.compile("([a-z])([A-Z])")

117
118
119
120
121
122
#: 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)))))

123

124
125
126
127
128
129
# 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))


130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
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)

150
151
152
153
154
155
156
157
158
159
160
161
162
163
164

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)


165
166
167
@ht.WithDesc("CheckFileStorage")
def _CheckFileStorage(value):
  """Ensures file storage is enabled if used.
168
169

  """
170
  if value == constants.DT_FILE:
171
172
173
174
    RequireFileStorage()
  return True


175
176
177
178
_CheckDiskTemplate = ht.TAnd(ht.TElemOf(constants.DISK_TEMPLATES),
                             _CheckFileStorage)


179
180
181
182
183
184
185
186
187
188
189
190
191
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
192
193
_PStorageType = ("storage_type", ht.NoDefault, _CheckStorageType,
                 "Storage type")
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211


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

214
    attrs["OP_ID"] = _NameToId(name)
215
216
217
218
219

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

    # Use parameter names as slots
220
    slots = [pname for (pname, _, _, _) in params]
221
222
223
224
225
226
227
228

    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)

229

Iustin Pop's avatar
Iustin Pop committed
230
class BaseOpCode(object):
231
232
  """A simple serializable object.

Iustin Pop's avatar
Iustin Pop committed
233
234
235
  This object serves as a parent class for OpCode without any custom
  field handling.

236
  """
237
238
  # pylint: disable-msg=E1101
  # as OP_ID is dynamically defined
239
240
  __metaclass__ = _AutoOpParamSlots

Iustin Pop's avatar
Iustin Pop committed
241
  def __init__(self, **kwargs):
Iustin Pop's avatar
Iustin Pop committed
242
243
244
245
246
247
248
249
    """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.

    """
250
    slots = self._all_slots()
Iustin Pop's avatar
Iustin Pop committed
251
    for key in kwargs:
252
      if key not in slots:
253
        raise TypeError("Object %s doesn't support the parameter '%s'" %
254
                        (self.__class__.__name__, key))
Iustin Pop's avatar
Iustin Pop committed
255
256
      setattr(self, key, kwargs[key])

257
  def __getstate__(self):
Iustin Pop's avatar
Iustin Pop committed
258
259
260
261
262
263
264
265
266
    """Generic serializer.

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

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

    """
267
    state = {}
268
    for name in self._all_slots():
269
270
271
272
273
      if hasattr(self, name):
        state[name] = getattr(self, name)
    return state

  def __setstate__(self, state):
Iustin Pop's avatar
Iustin Pop committed
274
275
276
277
278
279
280
281
282
    """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}

    """
283
284
285
286
    if not isinstance(state, dict):
      raise ValueError("Invalid data to __setstate__: expected dict, got %s" %
                       type(state))

287
    for name in self._all_slots():
Iustin Pop's avatar
Iustin Pop committed
288
      if name not in state and hasattr(self, name):
289
290
291
292
293
        delattr(self, name)

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

294
295
296
297
298
299
300
301
302
303
  @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

304
305
306
307
308
309
310
311
312
313
  @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

314
315
316
317
318
319
320
321
322
  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

    """
323
    for (attr_name, default, test, _) in self.GetAllParams():
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
      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)

351

Iustin Pop's avatar
Iustin Pop committed
352
class OpCode(BaseOpCode):
Iustin Pop's avatar
Iustin Pop committed
353
354
355
356
357
358
  """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
359
               children of this class.
360
361
362
  @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).
363
364
  @cvar OP_PARAMS: List of opcode attributes, the default values they should
                   get if not already defined, and types they must match.
365
366
  @cvar WITH_LU: Boolean that specifies whether this should be included in
      mcpu's dispatch table
367
368
  @ivar dry_run: Whether the LU should be run in dry-run mode, i.e. just
                 the check steps
369
  @ivar priority: Opcode priority for queue
Iustin Pop's avatar
Iustin Pop committed
370
371

  """
372
373
  # pylint: disable-msg=E1101
  # as OP_ID is dynamically defined
374
  WITH_LU = True
375
  OP_PARAMS = [
376
377
    ("dry_run", None, ht.TMaybeBool, "Run checks only, don't execute"),
    ("debug_level", None, ht.TOr(ht.TNone, ht.TPositiveInt), "Debug level"),
378
    ("priority", constants.OP_PRIO_DEFAULT,
379
     ht.TElemOf(constants.OP_PRIO_SUBMIT_VALID), "Opcode priority"),
380
    ]
381
382
383
384

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

Iustin Pop's avatar
Iustin Pop committed
385
386
387
388
389
390
391
    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

392
    """
Iustin Pop's avatar
Iustin Pop committed
393
    data = BaseOpCode.__getstate__(self)
394
395
396
397
    data["OP_ID"] = self.OP_ID
    return data

  @classmethod
398
  def LoadOpCode(cls, data):
399
400
    """Generic load opcode method.

Iustin Pop's avatar
Iustin Pop committed
401
402
403
404
405
406
407
    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

408
409
410
411
412
413
414
    """
    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
415
416
417
    if op_id in OP_MAPPING:
      op_class = OP_MAPPING[op_id]
    else:
418
419
420
421
422
423
424
425
      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

426
427
428
  def Summary(self):
    """Generates a summary description of this opcode.

429
430
431
432
433
    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).
434

435
    """
436
    assert self.OP_ID is not None and len(self.OP_ID) > 3
437
438
439
440
441
    # 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)
442
443
      if isinstance(field_value, (list, tuple)):
        field_value = ",".join(str(i) for i in field_value)
444
445
446
      txt = "%s(%s)" % (txt, field_value)
    return txt

Iustin Pop's avatar
Iustin Pop committed
447

448
449
# cluster opcodes

450
class OpClusterPostInit(OpCode):
451
452
453
454
455
456
457
458
  """Post cluster initialization.

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

  """


459
class OpClusterDestroy(OpCode):
Iustin Pop's avatar
Iustin Pop committed
460
461
462
463
464
465
  """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
466
467


468
class OpClusterQuery(OpCode):
Iustin Pop's avatar
Iustin Pop committed
469
  """Query cluster information."""
Iustin Pop's avatar
Iustin Pop committed
470
471


472
class OpClusterVerify(OpCode):
Iustin Pop's avatar
Iustin Pop committed
473
474
475
476
477
478
479
480
481
  """Verify the cluster state.

  @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

  """
482
483
  OP_PARAMS = [
    ("skip_checks", ht.EmptyList,
484
485
486
487
     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),
488
    ]
Iustin Pop's avatar
Iustin Pop committed
489
490


491
class OpClusterVerifyDisks(OpCode):
Iustin Pop's avatar
Iustin Pop committed
492
493
494
495
  """Verify the cluster disks.

  Parameters: none

496
  Result: a tuple of four elements:
Iustin Pop's avatar
Iustin Pop committed
497
    - list of node names with bad data returned (unreachable, etc.)
Iustin Pop's avatar
Iustin Pop committed
498
    - dict of node names with broken volume groups (values: error msg)
Iustin Pop's avatar
Iustin Pop committed
499
    - list of instances with degraded disks (that should be activated)
500
501
    - dict of instances with missing logical volumes (values: (node, vol)
      pairs with details about the missing volumes)
Iustin Pop's avatar
Iustin Pop committed
502

503
504
505
506
  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
507
508
509
510
511
512
513

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

  """


514
class OpClusterRepairDiskSizes(OpCode):
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
  """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

  """
530
  OP_PARAMS = [
531
    ("instances", ht.EmptyList, ht.TListOf(ht.TNonEmptyString), None),
532
    ]
533
534


535
class OpClusterConfigQuery(OpCode):
536
  """Query cluster configuration values."""
537
538
539
  OP_PARAMS = [
    _POutputFields
    ]
Iustin Pop's avatar
Iustin Pop committed
540
541


542
class OpClusterRename(OpCode):
Iustin Pop's avatar
Iustin Pop committed
543
544
545
546
547
548
549
550
  """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.

  """
551
  OP_DSC_FIELD = "name"
552
  OP_PARAMS = [
553
    ("name", ht.NoDefault, ht.TNonEmptyString, None),
554
    ]
555
556


557
class OpClusterSetParams(OpCode):
Iustin Pop's avatar
Iustin Pop committed
558
559
560
561
562
563
  """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.

  """
564
  OP_PARAMS = [
565
    ("vg_name", None, ht.TMaybeString, "Volume group name"),
566
567
    ("enabled_hypervisors", None,
     ht.TOr(ht.TAnd(ht.TListOf(ht.TElemOf(constants.HYPER_TYPES)), ht.TTrue),
568
569
            ht.TNone),
     "List of enabled hypervisors"),
570
    ("hvparams", None, ht.TOr(ht.TDictOf(ht.TNonEmptyString, ht.TDict),
571
572
573
574
                              ht.TNone),
     "Cluster-wide hypervisor parameter defaults, hypervisor-dependent"),
    ("beparams", None, ht.TOr(ht.TDict, ht.TNone),
     "Cluster-wide backend parameter defaults"),
575
    ("os_hvp", None, ht.TOr(ht.TDictOf(ht.TNonEmptyString, ht.TDict),
576
577
                            ht.TNone),
     "Cluster-wide per-OS hypervisor parameter defaults"),
578
    ("osparams", None, ht.TOr(ht.TDictOf(ht.TNonEmptyString, ht.TDict),
579
580
                              ht.TNone),
     "Cluster-wide OS parameter defaults"),
581
    ("candidate_pool_size", None, ht.TOr(ht.TStrictPositiveInt, ht.TNone),
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
     "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)),
613
    ]
614
615


616
class OpClusterRedistConf(OpCode):
617
618
619
620
  """Force a full push of the cluster configuration.

  """

Michael Hanselmann's avatar
Michael Hanselmann committed
621
622
623
624
625
626
627
628
629

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

  @ivar what: Resources to query for, must be one of L{constants.QR_OP_QUERY}
  @ivar fields: List of fields to retrieve
  @ivar filter: Query filter

  """
630
  OP_PARAMS = [
631
632
633
634
    ("what", ht.NoDefault, ht.TElemOf(constants.QR_OP_QUERY),
     "Resource(s) to query for"),
    ("fields", ht.NoDefault, ht.TListOf(ht.TNonEmptyString),
     "Requested fields"),
635
    ("filter", None, ht.TOr(ht.TNone,
636
637
                            ht.TListOf(ht.TOr(ht.TNonEmptyString, ht.TList))),
     "Query filter"),
Michael Hanselmann's avatar
Michael Hanselmann committed
638
639
640
641
642
643
644
645
646
647
    ]


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

  @ivar what: Resources to query for, must be one of L{constants.QR_OP_QUERY}
  @ivar fields: List of fields to retrieve

  """
648
  OP_PARAMS = [
649
650
    ("what", ht.NoDefault, ht.TElemOf(constants.QR_OP_QUERY), None),
    ("fields", None, ht.TOr(ht.TNone, ht.TListOf(ht.TNonEmptyString)), None),
Michael Hanselmann's avatar
Michael Hanselmann committed
651
652
653
    ]


654
class OpOobCommand(OpCode):
René Nussbaumer's avatar
René Nussbaumer committed
655
  """Interact with OOB."""
656
  OP_PARAMS = [
657
658
659
660
    ("node_names", ht.EmptyList, ht.TListOf(ht.TNonEmptyString), None),
    ("command", None, ht.TElemOf(constants.OOB_COMMANDS), None),
    ("timeout", constants.OOB_TIMEOUT, ht.TInt, None),
    ("ignore_status", False, ht.TBool, None),
René Nussbaumer's avatar
René Nussbaumer committed
661
662
663
    ]


664
665
# node opcodes

666
class OpNodeRemove(OpCode):
Iustin Pop's avatar
Iustin Pop committed
667
668
669
670
671
672
673
  """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.

  """
674
  OP_DSC_FIELD = "node_name"
675
676
677
  OP_PARAMS = [
    _PNodeName,
    ]
Iustin Pop's avatar
Iustin Pop committed
678
679


Iustin Pop's avatar
Iustin Pop committed
680
class OpNodeAdd(OpCode):
Iustin Pop's avatar
Iustin Pop committed
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
  """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.
700
701
  @type group: C{str}
  @ivar group: The node group to which this node will belong.
702
703
704
705
  @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
706
707

  """
708
  OP_DSC_FIELD = "node_name"
709
710
  OP_PARAMS = [
    _PNodeName,
711
712
713
714
715
716
717
718
719
    ("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"),
720
    ]
Iustin Pop's avatar
Iustin Pop committed
721
722


723
class OpNodeQuery(OpCode):
Iustin Pop's avatar
Iustin Pop committed
724
  """Compute the list of nodes."""
725
726
  OP_PARAMS = [
    _POutputFields,
727
728
729
    _PUseLocking,
    ("names", ht.EmptyList, ht.TListOf(ht.TNonEmptyString),
     "Empty list to query all nodes, node names otherwise"),
730
    ]
Iustin Pop's avatar
Iustin Pop committed
731
732


733
class OpNodeQueryvols(OpCode):
734
  """Get list of volumes on node."""
735
736
  OP_PARAMS = [
    _POutputFields,
737
738
    ("nodes", ht.EmptyList, ht.TListOf(ht.TNonEmptyString),
     "Empty list to query all nodes, node names otherwise"),
739
    ]
740
741


742
class OpNodeQueryStorage(OpCode):
743
  """Get information on storage for node(s)."""
744
745
746
  OP_PARAMS = [
    _POutputFields,
    _PStorageType,
747
748
    ("nodes", ht.EmptyList, ht.TListOf(ht.TNonEmptyString), "List of nodes"),
    ("name", None, ht.TMaybeString, "Storage name"),
749
750
751
    ]


752
class OpNodeModifyStorage(OpCode):
753
  """Modifies the properies of a storage unit"""
754
755
756
  OP_PARAMS = [
    _PNodeName,
    _PStorageType,
757
758
    _PStorageName,
    ("changes", ht.NoDefault, ht.TDict, "Requested changes"),
759
760
761
    ]


762
763
764
class OpRepairNodeStorage(OpCode):
  """Repairs the volume group on a node."""
  OP_DSC_FIELD = "node_name"
765
766
767
  OP_PARAMS = [
    _PNodeName,
    _PStorageType,
768
769
    _PStorageName,
    _PIgnoreConsistency,
770
771
772
    ]


773
class OpNodeSetParams(OpCode):
Iustin Pop's avatar
Iustin Pop committed
774
775
  """Change the parameters of a node."""
  OP_DSC_FIELD = "node_name"
776
777
778
  OP_PARAMS = [
    _PNodeName,
    _PForce,
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
    ("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
796
797
    ]

Iustin Pop's avatar
Iustin Pop committed
798

799
class OpNodePowercycle(OpCode):
Iustin Pop's avatar
Iustin Pop committed
800
801
  """Tries to powercycle a node."""
  OP_DSC_FIELD = "node_name"
802
803
804
  OP_PARAMS = [
    _PNodeName,
    _PForce,
Iustin Pop's avatar
Iustin Pop committed
805
806
    ]

807

808
class OpNodeMigrate(OpCode):
809
810
  """Migrate all instances from a node."""
  OP_DSC_FIELD = "node_name"
811
812
813
814
  OP_PARAMS = [
    _PNodeName,
    _PMigrationMode,
    _PMigrationLive,
815
816
817
    ]


818
class OpNodeEvacStrategy(OpCode):
819
820
  """Compute the evacuation strategy for a list of nodes."""
  OP_DSC_FIELD = "nodes"
821
  OP_PARAMS = [
822
823
824
    ("nodes", ht.NoDefault, ht.TListOf(ht.TNonEmptyString), None),
    ("remote_node", None, ht.TMaybeString, None),
    ("iallocator", None, ht.TMaybeString, None),
825
    ]
826
827


Iustin Pop's avatar
Iustin Pop committed
828
829
# instance opcodes

830
class OpInstanceCreate(OpCode):
831
832
833
834
835
836
837
  """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)
838
839
  @ivar source_shutdown_timeout: Shutdown timeout used for source instance
    (remote import only)
840
841

  """
842
  OP_DSC_FIELD = "instance_name"
843
844
  OP_PARAMS = [
    _PInstanceName,
845
846
847
848
    _PForceVariant,
    _PWaitForSync,
    _PNameCheck,
    ("beparams", ht.EmptyDict, ht.TDict, "Backend parameters for instance"),
849
850
851
852
853
854
855
856
857
858
859
    ("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)))),
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
    ("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"),
875
876
877
878
879
880
    ("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)))),
881
882
883
884
885
886
887
888
889
890
    ("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)"),
891
    ("source_shutdown_timeout", constants.DEFAULT_SHUTDOWN_TIMEOUT,
892
893
     ht.TPositiveInt,
     "How long source instance was given to shut down (remote import only)"),
894
895
896
897
898
    ("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"),
899
    ]
Iustin Pop's avatar
Iustin Pop committed
900
901


902
class OpInstanceReinstall(OpCode):
Iustin Pop's avatar
Iustin Pop committed
903
  """Reinstall an instance's OS."""
904
  OP_DSC_FIELD = "instance_name"
905
906
  OP_PARAMS = [
    _PInstanceName,
907
908
909
    _PForceVariant,
    ("os_type", None, ht.TMaybeString, "Instance operating system"),
    ("osparams", None, ht.TMaybeDict, "Temporary OS parameters"),
910
    ]
911
912


913
class OpInstanceRemove(OpCode):
Iustin Pop's avatar
Iustin Pop committed
914
  """Remove an instance."""
915
  OP_DSC_FIELD = "instance_name"
916
917
918
  OP_PARAMS = [
    _PInstanceName,
    _PShutdownTimeout,
919
920
    ("ignore_failures", False, ht.TBool,
     "Whether to ignore failures during removal"),
921
    ]
Iustin Pop's avatar
Iustin Pop committed
922
923


924
class OpInstanceRename(OpCode):
925
  """Rename an instance."""
926
927
  OP_PARAMS = [
    _PInstanceName,
928
929
930
    _PNameCheck,
    ("new_name", ht.NoDefault, ht.TNonEmptyString, "New instance name"),
    ("ip_check", False, ht.TBool, _PIpCheckDoc),
931
    ]
932
933


934
class OpInstanceStartup(OpCode):
Iustin Pop's avatar
Iustin Pop committed
935
  """Startup an instance."""
936
  OP_DSC_FIELD = "instance_name"
937
938
939
940
  OP_PARAMS = [
    _PInstanceName,
    _PForce,
    _PIgnoreOfflineNodes,
941
942
943
    ("hvparams", ht.EmptyDict, ht.TDict,
     "Temporary hypervisor parameters, hypervisor-dependent"),
    ("beparams", ht.EmptyDict, ht.TDict, "Temporary backend parameters"),
944
    ]
Iustin Pop's avatar
Iustin Pop committed
945
946


947
class OpInstanceShutdown(OpCode):
Iustin Pop's avatar
Iustin Pop committed
948
  """Shutdown an instance."""
949
  OP_DSC_FIELD = "instance_name"
950
951
952
  OP_PARAMS = [
    _PInstanceName,
    _PIgnoreOfflineNodes,
953
954
    ("timeout", constants.DEFAULT_SHUTDOWN_TIMEOUT, ht.TPositiveInt,
     "How long to wait for instance to shut down"),
955
    ]
Iustin Pop's avatar
Iustin Pop committed
956
957


958
class OpInstanceReboot(OpCode):
959
  """Reboot an instance."""
960
  OP_DSC_FIELD = "instance_name"
961
962
963
  OP_PARAMS = [
    _PInstanceName,
    _PShutdownTimeout,
964
965
966
967
    ("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"),
968
    ]
969
970


971
class OpInstanceReplaceDisks(OpCode):
Iustin Pop's avatar
Iustin Pop committed
972
  """Replace the disks of an instance."""
973
  OP_DSC_FIELD = "instance_name"
974
975
  OP_PARAMS = [
    _PInstanceName,
976
977
978
979
980
981
982
983
984
    ("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"),
985
    ]
Iustin Pop's avatar
Iustin Pop committed
986
987


988
class OpInstanceFailover(OpCode):
Iustin Pop's avatar
Iustin Pop committed
989
  """Failover an instance."""
990
  OP_DSC_FIELD = "instance_name"
991
992
993
  OP_PARAMS = [
    _PInstanceName,
    _PShutdownTimeout,
994
    _PIgnoreConsistency,
995
    ]
Iustin Pop's avatar
Iustin Pop committed
996
997


998
class OpInstanceMigrate(OpCode):
999
1000
1001
1002
1003
  """Migrate an instance.

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

Iustin Pop's avatar
Iustin Pop committed
1004
  @ivar instance_name: the name of the instance
1005
  @ivar mode: the migration mode (live, non-live or None for auto)
1006
1007

  """
Iustin Pop's avatar
Iustin Pop committed
1008
  OP_DSC_FIELD = "instance_name"
1009
1010
1011
1012
  OP_PARAMS = [
    _PInstanceName,
    _PMigrationMode,
    _PMigrationLive,
1013
1014
    ("cleanup", False, ht.TBool,
     "Whether a previously failed migration should be cleaned up"),
1015
    ]
1016
1017


1018
class OpInstanceMove(OpCode):
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
  """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"
1029
1030
1031
  OP_PARAMS = [
    _PInstanceName,
    _PShutdownTimeout,
1032
    ("target_node", ht.NoDefault, ht.TNonEmptyString, "Target node"),
Balazs Lecz's avatar
Balazs Lecz committed
1033
    ]
1034
1035


1036
class OpInstanceConsole(OpCode):
Iustin Pop's avatar
Iustin Pop committed
1037
  """Connect to an instance's console."""
1038
  OP_DSC_FIELD = "instance_name"
1039
1040
1041
  OP_PARAMS = [
    _PInstanceName
    ]
Iustin Pop's avatar
Iustin Pop committed
1042
1043


1044
class OpInstanceActivateDisks(OpCode):
Iustin Pop's avatar
Iustin Pop committed
1045
  """Activate an instance's disks."""
1046
  OP_DSC_FIELD = "instance_name"
1047
1048
  OP_PARAMS = [
    _PInstanceName,
1049
    ("ignore_size", False, ht.TBool, "Whether to ignore recorded size"),
1050
    ]
Iustin Pop's avatar
Iustin Pop committed
1051
1052


1053
class OpInstanceDeactivateDisks(OpCode):
Iustin Pop's avatar
Iustin Pop committed
1054
  """Deactivate an instance's disks."""
1055
  OP_DSC_FIELD = "instance_name"
1056
  OP_PARAMS = [
1057
1058
    _PInstanceName,
    _PForce,
1059
    ]
Iustin Pop's avatar
Iustin Pop committed
1060
1061


1062
class OpInstanceRecreateDisks(OpCode):
Iustin Pop's avatar
Iustin Pop committed
1063
1064
  """Deactivate an instance's disks."""
  OP_DSC_FIELD = "instance_name"
1065
1066
  OP_PARAMS = [
    _PInstanceName,
1067
1068
    ("disks", ht.EmptyList, ht.TListOf(ht.TPositiveInt),
     "List of disk indexes"),
1069
    ]
Iustin Pop's avatar
Iustin Pop committed
1070
1071


1072
class OpInstanceQuery(OpCode):
Iustin Pop's avatar
Iustin Pop committed
1073
  """Compute the list of instances."""
1074
1075
  OP_PARAMS = [
    _POutputFields,
1076
1077
1078
    _PUseLocking,
    ("names", ht.EmptyList, ht.TListOf(ht.TNonEmptyString),
     "Empty list to query all instances, instance names otherwise"),
1079
    ]
Iustin Pop's avatar
Iustin Pop committed
1080
1081


1082
class OpInstanceQueryData(OpCode):
Iustin Pop's avatar
Iustin Pop committed
1083
  """Compute the run-time status of instances."""
1084
  OP_PARAMS = [
1085
1086
    ("instances", ht.EmptyList, ht.TListOf(ht.TNonEmptyString), None),
    ("static", False, ht.TBool, None),
1087
    ]
Iustin Pop's avatar
Iustin Pop committed
1088
1089


1090
class OpInstanceSetParams(OpCode):
Iustin Pop's avatar
Iustin Pop committed
1091
  """Change the parameters of an instance."""
1092
  OP_DSC_FIELD = "instance_name"
1093
1094
1095
  OP_PARAMS = [
    _PInstanceName,
    _PForce,
1096
    _PForceVariant,
1097
    # TODO: Use _TestNicDef
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
    ("nics", ht.EmptyList, ht.TList,
     "List of NIC changes. Each item is of the form ``(op, settings)``."
     " ``op`` can be ``%s`` to add a new NIC with the specified settings,"
     " ``%s`` to remove the last NIC or a number to modify the settings"
     " of the NIC with that index." %
     (constants.DDM_ADD, constants.DDM_REMOVE)),
    ("disks", ht.EmptyList, ht.TList, "List of disk changes. See ``nics``."),
    ("beparams", ht.EmptyDict, ht.TDict, "Per-instance backend parameters"),
    ("hvparams", ht.EmptyDict, ht.TDict,
     "Per-instance hypervisor parameters, hypervisor-dependent"),
    ("disk_template", None, ht.TOr(ht.TNone, _CheckDiskTemplate),
     "Disk template for instance"),
    ("remote_node", None, ht.TMaybeString,
     "Secondary node (used when changing disk template)"),
    ("os_name", None, ht.TMaybeString,
     "Change instance's OS name. Does not reinstall the instance."),
    ("osparams", None, ht.TMaybeDict, "Per-instance OS parameters"),
1115
    ]
Iustin Pop's avatar
Iustin Pop committed
1116
1117


Iustin Pop's avatar
Iustin Pop committed
1118
class OpInstanceGrowDisk(OpCode):
Iustin Pop's avatar
Iustin Pop committed
1119
  """Grow a disk of an instance."""
1120
  OP_DSC_FIELD = "instance_name"
1121
1122
  OP_PARAMS = [
    _PInstanceName,
1123
1124
1125
1126
    _PWaitForSync,
    ("disk", ht.NoDefault, ht.TInt, "Disk index"),
    ("amount", ht.NoDefault, ht.TInt,
     "Amount of disk space to add (megabytes)"),
1127
    ]
Iustin Pop's avatar
Iustin Pop committed
1128
1129


1130
1131
# Node group opcodes

Iustin Pop's avatar
Iustin Pop committed
1132
class OpGroupAdd(OpCode):
1133
1134
  """Add a node group to the cluster."""
  OP_DSC_FIELD = "group_name"
1135
1136
  OP_PARAMS = [
    _PGroupName,
1137
1138
    _PNodeGroupAllocPolicy,
    _PGroupNodeParams,
1139
    ]
1140
1141


1142
class OpGroupAssignNodes(OpCode):
1143
1144
1145
1146
1147
  """Assign nodes to a node group."""
  OP_DSC_FIELD = "group_name"
  OP_PARAMS = [
    _PGroupName,
    _PForce,
1148
1149
    ("nodes", ht.NoDefault, ht.TListOf(ht.TNonEmptyString),
     "List of nodes to assign"),
1150
1151
1152
    ]


1153