objects.py 40.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 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
27
28
#
# 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.


"""Transportable objects for Ganeti.

This module provides small, mostly data-only objects which are safe to
pass to and from external parties.

"""

Iustin Pop's avatar
Iustin Pop committed
29
# pylint: disable-msg=E0203,W0201
Iustin Pop's avatar
Iustin Pop committed
30
31
32
33

# E0203: Access to member %r before its definition, since we use
# objects.py which doesn't explicitely initialise its members

Iustin Pop's avatar
Iustin Pop committed
34
# W0201: Attribute '%s' defined outside __init__
Iustin Pop's avatar
Iustin Pop committed
35
36

import ConfigParser
37
import re
38
import copy
39
from cStringIO import StringIO
Iustin Pop's avatar
Iustin Pop committed
40
41

from ganeti import errors
42
from ganeti import constants
Iustin Pop's avatar
Iustin Pop committed
43

44
45
from socket import AF_INET

Iustin Pop's avatar
Iustin Pop committed
46
47

__all__ = ["ConfigObject", "ConfigData", "NIC", "Disk", "Instance",
48
           "OS", "Node", "NodeGroup", "Cluster", "FillDict"]
Iustin Pop's avatar
Iustin Pop committed
49

50
_TIMESTAMPS = ["ctime", "mtime"]
51
_UUID = ["uuid"]
52

53

54
def FillDict(defaults_dict, custom_dict, skip_keys=None):
Iustin Pop's avatar
Iustin Pop committed
55
  """Basic function to apply settings on top a default dict.
Guido Trotter's avatar
Guido Trotter committed
56

Iustin Pop's avatar
Iustin Pop committed
57
58
59
60
  @type defaults_dict: dict
  @param defaults_dict: dictionary holding the default values
  @type custom_dict: dict
  @param custom_dict: dictionary holding customized value
61
62
  @type skip_keys: list
  @param skip_keys: which keys not to fill
Iustin Pop's avatar
Iustin Pop committed
63
64
  @rtype: dict
  @return: dict with the 'full' values
Guido Trotter's avatar
Guido Trotter committed
65

Iustin Pop's avatar
Iustin Pop committed
66
67
68
  """
  ret_dict = copy.deepcopy(defaults_dict)
  ret_dict.update(custom_dict)
69
70
71
72
73
74
  if skip_keys:
    for k in skip_keys:
      try:
        del ret_dict[k]
      except KeyError:
        pass
Iustin Pop's avatar
Iustin Pop committed
75
  return ret_dict
Iustin Pop's avatar
Iustin Pop committed
76

77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94

def UpgradeGroupedParams(target, defaults):
  """Update all groups for the target parameter.

  @type target: dict of dicts
  @param target: {group: {parameter: value}}
  @type defaults: dict
  @param defaults: default parameter values

  """
  if target is None:
    target = {constants.PP_DEFAULT: defaults}
  else:
    for group in target:
      target[group] = FillDict(defaults, target[group])
  return target


Iustin Pop's avatar
Iustin Pop committed
95
96
97
98
99
100
101
102
103
104
class ConfigObject(object):
  """A generic config object.

  It has the following properties:

    - provides somewhat safe recursive unpickling and pickling for its classes
    - unset attributes which are defined in slots are always returned
      as None instead of raising an error

  Classes derived from this must always declare __slots__ (we use many
105
  config objects and the memory reduction is useful)
Iustin Pop's avatar
Iustin Pop committed
106
107
108
109
110

  """
  __slots__ = []

  def __init__(self, **kwargs):
111
112
    for k, v in kwargs.iteritems():
      setattr(self, k, v)
Iustin Pop's avatar
Iustin Pop committed
113
114

  def __getattr__(self, name):
115
    if name not in self._all_slots():
116
117
      raise AttributeError("Invalid object attribute %s.%s" %
                           (type(self).__name__, name))
Iustin Pop's avatar
Iustin Pop committed
118
119
120
    return None

  def __setstate__(self, state):
121
    slots = self._all_slots()
Iustin Pop's avatar
Iustin Pop committed
122
    for name in state:
123
      if name in slots:
Iustin Pop's avatar
Iustin Pop committed
124
125
        setattr(self, name, state[name])

126
127
128
129
130
131
132
133
134
135
  @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

136
137
138
139
140
141
142
143
144
145
  def ToDict(self):
    """Convert to a dict holding only standard python types.

    The generic routine just dumps all of this object's attributes in
    a dict. It does not work if the class has children who are
    ConfigObjects themselves (e.g. the nics list in an Instance), in
    which case the object should subclass the function in order to
    make sure all objects returned are only standard python types.

    """
146
    result = {}
147
    for name in self._all_slots():
148
149
150
151
152
153
      value = getattr(self, name, None)
      if value is not None:
        result[name] = value
    return result

  __getstate__ = ToDict
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170

  @classmethod
  def FromDict(cls, val):
    """Create an object from a dictionary.

    This generic routine takes a dict, instantiates a new instance of
    the given class, and sets attributes based on the dict content.

    As for `ToDict`, this does not work if the class has children
    who are ConfigObjects themselves (e.g. the nics list in an
    Instance), in which case the object should subclass the function
    and alter the objects.

    """
    if not isinstance(val, dict):
      raise errors.ConfigurationError("Invalid object passed to FromDict:"
                                      " expected dict, got %s" % type(val))
171
    val_str = dict([(str(k), v) for k, v in val.iteritems()])
Iustin Pop's avatar
Iustin Pop committed
172
    obj = cls(**val_str) # pylint: disable-msg=W0142
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
    return obj

  @staticmethod
  def _ContainerToDicts(container):
    """Convert the elements of a container to standard python types.

    This method converts a container with elements derived from
    ConfigData to standard python types. If the container is a dict,
    we don't touch the keys, only the values.

    """
    if isinstance(container, dict):
      ret = dict([(k, v.ToDict()) for k, v in container.iteritems()])
    elif isinstance(container, (list, tuple, set, frozenset)):
      ret = [elem.ToDict() for elem in container]
    else:
      raise TypeError("Invalid type %s passed to _ContainerToDicts" %
                      type(container))
    return ret

  @staticmethod
  def _ContainerFromDicts(source, c_type, e_type):
    """Convert a container from standard python types.

    This method converts a container with standard python types to
    ConfigData objects. If the container is a dict, we don't touch the
    keys, only the values.

    """
    if not isinstance(c_type, type):
      raise TypeError("Container type %s passed to _ContainerFromDicts is"
                      " not a type" % type(c_type))
205
206
    if source is None:
      source = c_type()
207
208
209
210
211
212
213
214
215
    if c_type is dict:
      ret = dict([(k, e_type.FromDict(v)) for k, v in source.iteritems()])
    elif c_type in (list, tuple, set, frozenset):
      ret = c_type([e_type.FromDict(elem) for elem in source])
    else:
      raise TypeError("Invalid container type %s passed to"
                      " _ContainerFromDicts" % c_type)
    return ret

216
217
218
219
220
221
222
223
  def Copy(self):
    """Makes a deep copy of the current object and its children.

    """
    dict_form = self.ToDict()
    clone_obj = self.__class__.FromDict(dict_form)
    return clone_obj

224
225
226
227
  def __repr__(self):
    """Implement __repr__ for ConfigObjects."""
    return repr(self.ToDict())

228
229
230
  def UpgradeConfig(self):
    """Fill defaults for missing configuration values.

231
232
    This method will be called at configuration load time, and its
    implementation will be object dependent.
233
234
235
236

    """
    pass

Iustin Pop's avatar
Iustin Pop committed
237

238
class TaggableObject(ConfigObject):
239
240
241
  """An generic class supporting tags.

  """
Balazs Lecz's avatar
Balazs Lecz committed
242
  __slots__ = ["tags"]
Iustin Pop's avatar
Iustin Pop committed
243
  VALID_TAG_RE = re.compile("^[\w.+*/:@-]+$")
Iustin Pop's avatar
Iustin Pop committed
244

Iustin Pop's avatar
Iustin Pop committed
245
246
  @classmethod
  def ValidateTag(cls, tag):
247
248
249
250
251
252
253
    """Check if a tag is valid.

    If the tag is invalid, an errors.TagError will be raised. The
    function has no return value.

    """
    if not isinstance(tag, basestring):
254
      raise errors.TagError("Invalid tag type (not a string)")
255
    if len(tag) > constants.MAX_TAG_LEN:
256
257
      raise errors.TagError("Tag too long (>%d characters)" %
                            constants.MAX_TAG_LEN)
258
    if not tag:
259
      raise errors.TagError("Tags cannot be empty")
Iustin Pop's avatar
Iustin Pop committed
260
    if not cls.VALID_TAG_RE.match(tag):
261
      raise errors.TagError("Tag contains invalid characters")
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278

  def GetTags(self):
    """Return the tags list.

    """
    tags = getattr(self, "tags", None)
    if tags is None:
      tags = self.tags = set()
    return tags

  def AddTag(self, tag):
    """Add a new tag.

    """
    self.ValidateTag(tag)
    tags = self.GetTags()
    if len(tags) >= constants.MAX_TAGS_PER_OBJ:
279
      raise errors.TagError("Too many tags")
280
281
282
283
284
285
286
287
288
289
290
    self.GetTags().add(tag)

  def RemoveTag(self, tag):
    """Remove a tag.

    """
    self.ValidateTag(tag)
    tags = self.GetTags()
    try:
      tags.remove(tag)
    except KeyError:
291
      raise errors.TagError("Tag not found")
292

293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
  def ToDict(self):
    """Taggable-object-specific conversion to standard python types.

    This replaces the tags set with a list.

    """
    bo = super(TaggableObject, self).ToDict()

    tags = bo.get("tags", None)
    if isinstance(tags, set):
      bo["tags"] = list(tags)
    return bo

  @classmethod
  def FromDict(cls, val):
    """Custom function for instances.

    """
    obj = super(TaggableObject, cls).FromDict(val)
    if hasattr(obj, "tags") and isinstance(obj.tags, list):
      obj.tags = set(obj.tags)
    return obj

316

Iustin Pop's avatar
Iustin Pop committed
317
318
class ConfigData(ConfigObject):
  """Top-level config object."""
319
320
321
322
323
324
325
326
  __slots__ = [
    "version",
    "cluster",
    "nodes",
    "nodegroups",
    "instances",
    "serial_no",
    ] + _TIMESTAMPS
Iustin Pop's avatar
Iustin Pop committed
327

328
329
330
331
332
333
334
335
336
  def ToDict(self):
    """Custom function for top-level config data.

    This just replaces the list of instances, nodes and the cluster
    with standard python types.

    """
    mydict = super(ConfigData, self).ToDict()
    mydict["cluster"] = mydict["cluster"].ToDict()
337
    for key in "nodes", "instances", "nodegroups":
338
339
340
341
342
343
344
345
346
347
348
349
350
      mydict[key] = self._ContainerToDicts(mydict[key])

    return mydict

  @classmethod
  def FromDict(cls, val):
    """Custom function for top-level config data

    """
    obj = super(ConfigData, cls).FromDict(val)
    obj.cluster = Cluster.FromDict(obj.cluster)
    obj.nodes = cls._ContainerFromDicts(obj.nodes, dict, Node)
    obj.instances = cls._ContainerFromDicts(obj.instances, dict, Instance)
351
    obj.nodegroups = cls._ContainerFromDicts(obj.nodegroups, dict, NodeGroup)
352
353
    return obj

354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
  def HasAnyDiskOfType(self, dev_type):
    """Check if in there is at disk of the given type in the configuration.

    @type dev_type: L{constants.LDS_BLOCK}
    @param dev_type: the type to look for
    @rtype: boolean
    @return: boolean indicating if a disk of the given type was found or not

    """
    for instance in self.instances.values():
      for disk in instance.disks:
        if disk.IsBasedOnDiskType(dev_type):
          return True
    return False

369
370
371
372
373
374
375
376
377
  def UpgradeConfig(self):
    """Fill defaults for missing configuration values.

    """
    self.cluster.UpgradeConfig()
    for node in self.nodes.values():
      node.UpgradeConfig()
    for instance in self.instances.values():
      instance.UpgradeConfig()
378
379
380
381
    if self.nodegroups is None:
      self.nodegroups = {}
    for nodegroup in self.nodegroups.values():
      nodegroup.UpgradeConfig()
382
383
384
385
386
387
    if self.cluster.drbd_usermode_helper is None:
      # To decide if we set an helper let's check if at least one instance has
      # a DRBD disk. This does not cover all the possible scenarios but it
      # gives a good approximation.
      if self.HasAnyDiskOfType(constants.LD_DRBD8):
        self.cluster.drbd_usermode_helper = constants.DEFAULT_DRBD_HELPER
388

Iustin Pop's avatar
Iustin Pop committed
389
390
391

class NIC(ConfigObject):
  """Config object representing a network card."""
392
  __slots__ = ["mac", "ip", "bridge", "nicparams"]
Iustin Pop's avatar
Iustin Pop committed
393

Guido Trotter's avatar
Guido Trotter committed
394
395
396
397
398
399
400
401
402
403
404
405
406
  @classmethod
  def CheckParameterSyntax(cls, nicparams):
    """Check the given parameters for validity.

    @type nicparams:  dict
    @param nicparams: dictionary with parameter names/value
    @raise errors.ConfigurationError: when a parameter is not valid

    """
    if nicparams[constants.NIC_MODE] not in constants.NIC_VALID_MODES:
      err = "Invalid nic mode: %s" % nicparams[constants.NIC_MODE]
      raise errors.ConfigurationError(err)

407
    if (nicparams[constants.NIC_MODE] == constants.NIC_MODE_BRIDGED and
Guido Trotter's avatar
Guido Trotter committed
408
409
410
411
        not nicparams[constants.NIC_LINK]):
      err = "Missing bridged nic link"
      raise errors.ConfigurationError(err)

412
413
414
415
416
417
418
419
420
  def UpgradeConfig(self):
    """Fill defaults for missing configuration values.

    """
    if self.nicparams is None:
      self.nicparams = {}
      if self.bridge is not None:
        self.nicparams[constants.NIC_MODE] = constants.NIC_MODE_BRIDGED
        self.nicparams[constants.NIC_LINK] = self.bridge
421
    # bridge is no longer used it 2.1. The slot is left there to support
422
423
    # upgrading, but can be removed once upgrades to the current version
    # straight from 2.0 are deprecated.
424
425
    if self.bridge is not None:
      self.bridge = None
426

Iustin Pop's avatar
Iustin Pop committed
427
428
429
430

class Disk(ConfigObject):
  """Config object representing a block device."""
  __slots__ = ["dev_type", "logical_id", "physical_id",
431
               "children", "iv_name", "size", "mode"]
Iustin Pop's avatar
Iustin Pop committed
432
433
434

  def CreateOnSecondary(self):
    """Test if this device needs to be created on a secondary node."""
435
    return self.dev_type in (constants.LD_DRBD8, constants.LD_LV)
Iustin Pop's avatar
Iustin Pop committed
436
437
438

  def AssembleOnSecondary(self):
    """Test if this device needs to be assembled on a secondary node."""
439
    return self.dev_type in (constants.LD_DRBD8, constants.LD_LV)
Iustin Pop's avatar
Iustin Pop committed
440
441
442

  def OpenOnSecondary(self):
    """Test if this device needs to be opened on a secondary node."""
443
    return self.dev_type in (constants.LD_LV,)
Iustin Pop's avatar
Iustin Pop committed
444

445
446
447
448
449
450
451
  def StaticDevPath(self):
    """Return the device path if this device type has a static one.

    Some devices (LVM for example) live always at the same /dev/ path,
    irrespective of their status. For such devices, we return this
    path, for others we return None.

452
453
454
    @warning: The path returned is not a normalized pathname; callers
        should check that it is a valid path.

455
456
457
458
459
    """
    if self.dev_type == constants.LD_LV:
      return "/dev/%s/%s" % (self.logical_id[0], self.logical_id[1])
    return None

460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
  def ChildrenNeeded(self):
    """Compute the needed number of children for activation.

    This method will return either -1 (all children) or a positive
    number denoting the minimum number of children needed for
    activation (only mirrored devices will usually return >=0).

    Currently, only DRBD8 supports diskless activation (therefore we
    return 0), for all other we keep the previous semantics and return
    -1.

    """
    if self.dev_type == constants.LD_DRBD8:
      return 0
    return -1

476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
  def IsBasedOnDiskType(self, dev_type):
    """Check if the disk or its children are based on the given type.

    @type dev_type: L{constants.LDS_BLOCK}
    @param dev_type: the type to look for
    @rtype: boolean
    @return: boolean indicating if a device of the given type was found or not

    """
    if self.children:
      for child in self.children:
        if child.IsBasedOnDiskType(dev_type):
          return True
    return self.dev_type == dev_type

Iustin Pop's avatar
Iustin Pop committed
491
492
493
494
495
496
497
498
499
  def GetNodes(self, node):
    """This function returns the nodes this device lives on.

    Given the node on which the parent of the device lives on (or, in
    case of a top-level device, the primary node of the devices'
    instance), this function will return a list of nodes on which this
    devices needs to (or can) be assembled.

    """
500
    if self.dev_type in [constants.LD_LV, constants.LD_FILE]:
Iustin Pop's avatar
Iustin Pop committed
501
      result = [node]
502
    elif self.dev_type in constants.LDS_DRBD:
Iustin Pop's avatar
Iustin Pop committed
503
504
      result = [self.logical_id[0], self.logical_id[1]]
      if node not in result:
505
        raise errors.ConfigurationError("DRBD device passed unknown node")
Iustin Pop's avatar
Iustin Pop committed
506
    else:
507
      raise errors.ProgrammerError("Unhandled device type %s" % self.dev_type)
Iustin Pop's avatar
Iustin Pop committed
508
509
510
511
512
513
514
    return result

  def ComputeNodeTree(self, parent_node):
    """Compute the node/disk tree for this disk and its children.

    This method, given the node on which the parent disk lives, will
    return the list of all (node, disk) pairs which describe the disk
515
516
517
    tree in the most compact way. For example, a drbd/lvm stack
    will be returned as (primary_node, drbd) and (secondary_node, drbd)
    which represents all the top-level devices on the nodes.
Iustin Pop's avatar
Iustin Pop committed
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544

    """
    my_nodes = self.GetNodes(parent_node)
    result = [(node, self) for node in my_nodes]
    if not self.children:
      # leaf device
      return result
    for node in my_nodes:
      for child in self.children:
        child_result = child.ComputeNodeTree(node)
        if len(child_result) == 1:
          # child (and all its descendants) is simple, doesn't split
          # over multiple hosts, so we don't need to describe it, our
          # own entry for this node describes it completely
          continue
        else:
          # check if child nodes differ from my nodes; note that
          # subdisk can differ from the child itself, and be instead
          # one of its descendants
          for subnode, subdisk in child_result:
            if subnode not in my_nodes:
              result.append((subnode, subdisk))
            # otherwise child is under our own node, so we ignore this
            # entry (but probably the other results in the list will
            # be different)
    return result

545
546
547
548
549
550
551
552
  def RecordGrow(self, amount):
    """Update the size of this disk after growth.

    This method recurses over the disks's children and updates their
    size correspondigly. The method needs to be kept in sync with the
    actual algorithms from bdev.

    """
Guido Trotter's avatar
Guido Trotter committed
553
    if self.dev_type == constants.LD_LV or self.dev_type == constants.LD_FILE:
554
555
556
557
558
559
560
561
562
      self.size += amount
    elif self.dev_type == constants.LD_DRBD8:
      if self.children:
        self.children[0].RecordGrow(amount)
      self.size += amount
    else:
      raise errors.ProgrammerError("Disk.RecordGrow called for unsupported"
                                   " disk type %s" % self.dev_type)

563
564
565
566
567
568
569
570
571
  def UnsetSize(self):
    """Sets recursively the size to zero for the disk and its children.

    """
    if self.children:
      for child in self.children:
        child.UnsetSize()
    self.size = 0

572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
  def SetPhysicalID(self, target_node, nodes_ip):
    """Convert the logical ID to the physical ID.

    This is used only for drbd, which needs ip/port configuration.

    The routine descends down and updates its children also, because
    this helps when the only the top device is passed to the remote
    node.

    Arguments:
      - target_node: the node we wish to configure for
      - nodes_ip: a mapping of node name to ip

    The target_node must exist in in nodes_ip, and must be one of the
    nodes in the logical ID for each of the DRBD devices encountered
    in the disk tree.

    """
    if self.children:
      for child in self.children:
        child.SetPhysicalID(target_node, nodes_ip)

    if self.logical_id is None and self.physical_id is not None:
      return
    if self.dev_type in constants.LDS_DRBD:
597
      pnode, snode, port, pminor, sminor, secret = self.logical_id
598
599
600
601
602
603
604
605
      if target_node not in (pnode, snode):
        raise errors.ConfigurationError("DRBD device not knowing node %s" %
                                        target_node)
      pnode_ip = nodes_ip.get(pnode, None)
      snode_ip = nodes_ip.get(snode, None)
      if pnode_ip is None or snode_ip is None:
        raise errors.ConfigurationError("Can't find primary or secondary node"
                                        " for %s" % str(self))
606
607
      p_data = (pnode_ip, port)
      s_data = (snode_ip, port)
608
      if pnode == target_node:
609
        self.physical_id = p_data + s_data + (pminor, secret)
610
      else: # it must be secondary, we tested above
611
        self.physical_id = s_data + p_data + (sminor, secret)
612
613
614
615
    else:
      self.physical_id = self.logical_id
    return

616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
  def ToDict(self):
    """Disk-specific conversion to standard python types.

    This replaces the children lists of objects with lists of
    standard python types.

    """
    bo = super(Disk, self).ToDict()

    for attr in ("children",):
      alist = bo.get(attr, None)
      if alist:
        bo[attr] = self._ContainerToDicts(alist)
    return bo

  @classmethod
  def FromDict(cls, val):
    """Custom function for Disks

    """
    obj = super(Disk, cls).FromDict(val)
    if obj.children:
      obj.children = cls._ContainerFromDicts(obj.children, list, Disk)
    if obj.logical_id and isinstance(obj.logical_id, list):
      obj.logical_id = tuple(obj.logical_id)
    if obj.physical_id and isinstance(obj.physical_id, list):
      obj.physical_id = tuple(obj.physical_id)
643
644
645
646
    if obj.dev_type in constants.LDS_DRBD:
      # we need a tuple of length six here
      if len(obj.logical_id) < 6:
        obj.logical_id += (None,) * (6 - len(obj.logical_id))
647
648
    return obj

649
650
651
652
653
654
655
  def __str__(self):
    """Custom str() formatter for disks.

    """
    if self.dev_type == constants.LD_LV:
      val =  "<LogicalVolume(/dev/%s/%s" % self.logical_id
    elif self.dev_type in constants.LDS_DRBD:
656
      node_a, node_b, port, minor_a, minor_b = self.logical_id[:5]
657
      val = "<DRBD8("
658
659
660
661
      if self.physical_id is None:
        phy = "unconfigured"
      else:
        phy = ("configured as %s:%s %s:%s" %
662
663
               (self.physical_id[0], self.physical_id[1],
                self.physical_id[2], self.physical_id[3]))
664

665
666
      val += ("hosts=%s/%d-%s/%d, port=%s, %s, " %
              (node_a, minor_a, node_b, minor_b, port, phy))
667
668
669
670
671
672
673
674
675
676
677
      if self.children and self.children.count(None) == 0:
        val += "backend=%s, metadev=%s" % (self.children[0], self.children[1])
      else:
        val += "no local storage"
    else:
      val = ("<Disk(type=%s, logical_id=%s, physical_id=%s, children=%s" %
             (self.dev_type, self.logical_id, self.physical_id, self.children))
    if self.iv_name is None:
      val += ", not visible"
    else:
      val += ", visible as /dev/%s" % self.iv_name
Iustin Pop's avatar
Iustin Pop committed
678
679
680
681
    if isinstance(self.size, int):
      val += ", size=%dm)>" % self.size
    else:
      val += ", size='%s')>" % (self.size,)
682
683
    return val

684
685
686
687
  def Verify(self):
    """Checks that this disk is correctly configured.

    """
Michael Hanselmann's avatar
Michael Hanselmann committed
688
    all_errors = []
689
    if self.mode not in constants.DISK_ACCESS_SET:
Michael Hanselmann's avatar
Michael Hanselmann committed
690
691
      all_errors.append("Disk access mode '%s' is invalid" % (self.mode, ))
    return all_errors
692

693
694
695
696
697
698
699
700
701
  def UpgradeConfig(self):
    """Fill defaults for missing configuration values.

    """
    if self.children:
      for child in self.children:
        child.UpgradeConfig()
    # add here config upgrade for this disk

Iustin Pop's avatar
Iustin Pop committed
702

703
class Instance(TaggableObject):
Iustin Pop's avatar
Iustin Pop committed
704
  """Config object representing an instance."""
Balazs Lecz's avatar
Balazs Lecz committed
705
  __slots__ = [
Iustin Pop's avatar
Iustin Pop committed
706
707
708
    "name",
    "primary_node",
    "os",
709
    "hypervisor",
710
711
    "hvparams",
    "beparams",
712
    "osparams",
713
    "admin_up",
Iustin Pop's avatar
Iustin Pop committed
714
715
716
    "nics",
    "disks",
    "disk_template",
717
    "network_port",
718
    "serial_no",
719
    ] + _TIMESTAMPS + _UUID
Iustin Pop's avatar
Iustin Pop committed
720
721
722
723

  def _ComputeSecondaryNodes(self):
    """Compute the list of secondary nodes.

724
725
726
727
728
729
730
731
732
733
734
735
736
    This is a simple wrapper over _ComputeAllNodes.

    """
    all_nodes = set(self._ComputeAllNodes())
    all_nodes.discard(self.primary_node)
    return tuple(all_nodes)

  secondary_nodes = property(_ComputeSecondaryNodes, None, None,
                             "List of secondary nodes")

  def _ComputeAllNodes(self):
    """Compute the list of all nodes.

Iustin Pop's avatar
Iustin Pop committed
737
738
739
740
741
742
    Since the data is already there (in the drbd disks), keeping it as
    a separate normal attribute is redundant and if not properly
    synchronised can cause problems. Thus it's better to compute it
    dynamically.

    """
743
744
    def _Helper(nodes, device):
      """Recursively computes nodes given a top device."""
745
      if device.dev_type in constants.LDS_DRBD:
746
747
748
        nodea, nodeb = device.logical_id[:2]
        nodes.add(nodea)
        nodes.add(nodeb)
Iustin Pop's avatar
Iustin Pop committed
749
750
      if device.children:
        for child in device.children:
751
          _Helper(nodes, child)
Iustin Pop's avatar
Iustin Pop committed
752

753
    all_nodes = set()
Iustin Pop's avatar
Iustin Pop committed
754
    all_nodes.add(self.primary_node)
Iustin Pop's avatar
Iustin Pop committed
755
    for device in self.disks:
756
757
      _Helper(all_nodes, device)
    return tuple(all_nodes)
Iustin Pop's avatar
Iustin Pop committed
758

759
760
  all_nodes = property(_ComputeAllNodes, None, None,
                       "List of all nodes of the instance")
Iustin Pop's avatar
Iustin Pop committed
761
762
763
764

  def MapLVsByNode(self, lvmap=None, devs=None, node=None):
    """Provide a mapping of nodes to LVs this instance owns.

Iustin Pop's avatar
Iustin Pop committed
765
766
    This function figures out what logical volumes should belong on
    which nodes, recursing through a device tree.
Iustin Pop's avatar
Iustin Pop committed
767

Iustin Pop's avatar
Iustin Pop committed
768
769
    @param lvmap: optional dictionary to receive the
        'node' : ['lv', ...] data.
Iustin Pop's avatar
Iustin Pop committed
770

Iustin Pop's avatar
Iustin Pop committed
771
772
    @return: None if lvmap arg is given, otherwise, a dictionary
        of the form { 'nodename' : ['volume1', 'volume2', ...], ... }
Iustin Pop's avatar
Iustin Pop committed
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789

    """
    if node == None:
      node = self.primary_node

    if lvmap is None:
      lvmap = { node : [] }
      ret = lvmap
    else:
      if not node in lvmap:
        lvmap[node] = []
      ret = None

    if not devs:
      devs = self.disks

    for dev in devs:
790
      if dev.dev_type == constants.LD_LV:
Iustin Pop's avatar
Iustin Pop committed
791
792
        lvmap[node].append(dev.logical_id[1])

793
      elif dev.dev_type in constants.LDS_DRBD:
Iustin Pop's avatar
Iustin Pop committed
794
795
796
797
798
799
800
801
802
        if dev.children:
          self.MapLVsByNode(lvmap, dev.children, dev.logical_id[0])
          self.MapLVsByNode(lvmap, dev.children, dev.logical_id[1])

      elif dev.children:
        self.MapLVsByNode(lvmap, dev.children, node)

    return ret

803
804
  def FindDisk(self, idx):
    """Find a disk given having a specified index.
805

806
    This is just a wrapper that does validation of the index.
807

808
809
810
811
812
    @type idx: int
    @param idx: the disk index
    @rtype: L{Disk}
    @return: the corresponding disk
    @raise errors.OpPrereqError: when the given index is not valid
813

814
815
816
817
    """
    try:
      idx = int(idx)
      return self.disks[idx]
818
    except (TypeError, ValueError), err:
819
820
      raise errors.OpPrereqError("Invalid disk index: '%s'" % str(err),
                                 errors.ECODE_INVAL)
821
822
    except IndexError:
      raise errors.OpPrereqError("Invalid disk index: %d (instace has disks"
823
824
                                 " 0 to %d" % (idx, len(self.disks)),
                                 errors.ECODE_INVAL)
825

826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
  def ToDict(self):
    """Instance-specific conversion to standard python types.

    This replaces the children lists of objects with lists of standard
    python types.

    """
    bo = super(Instance, self).ToDict()

    for attr in "nics", "disks":
      alist = bo.get(attr, None)
      if alist:
        nlist = self._ContainerToDicts(alist)
      else:
        nlist = []
      bo[attr] = nlist
    return bo

  @classmethod
  def FromDict(cls, val):
    """Custom function for instances.

    """
    obj = super(Instance, cls).FromDict(val)
    obj.nics = cls._ContainerFromDicts(obj.nics, list, NIC)
    obj.disks = cls._ContainerFromDicts(obj.disks, list, Disk)
    return obj

854
855
856
857
858
859
860
861
  def UpgradeConfig(self):
    """Fill defaults for missing configuration values.

    """
    for nic in self.nics:
      nic.UpgradeConfig()
    for disk in self.disks:
      disk.UpgradeConfig()
862
863
864
865
866
867
    if self.hvparams:
      for key in constants.HVC_GLOBALS:
        try:
          del self.hvparams[key]
        except KeyError:
          pass
868
869
    if self.osparams is None:
      self.osparams = {}
870

Iustin Pop's avatar
Iustin Pop committed
871
872

class OS(ConfigObject):
873
874
875
876
877
878
  """Config object representing an operating system.

  @type supported_parameters: list
  @ivar supported_parameters: a list of tuples, name and description,
      containing the supported parameters by this OS

879
880
881
  @type VARIANT_DELIM: string
  @cvar VARIANT_DELIM: the variant delimiter

882
  """
Iustin Pop's avatar
Iustin Pop committed
883
884
885
  __slots__ = [
    "name",
    "path",
886
    "api_versions",
Iustin Pop's avatar
Iustin Pop committed
887
888
    "create_script",
    "export_script",
889
890
    "import_script",
    "rename_script",
891
    "verify_script",
892
    "supported_variants",
893
    "supported_parameters",
Iustin Pop's avatar
Iustin Pop committed
894
895
    ]

896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
  VARIANT_DELIM = "+"

  @classmethod
  def SplitNameVariant(cls, name):
    """Splits the name into the proper name and variant.

    @param name: the OS (unprocessed) name
    @rtype: list
    @return: a list of two elements; if the original name didn't
        contain a variant, it's returned as an empty string

    """
    nv = name.split(cls.VARIANT_DELIM, 1)
    if len(nv) == 1:
      nv.append("")
    return nv

  @classmethod
  def GetName(cls, name):
    """Returns the proper name of the os (without the variant).

    @param name: the OS (unprocessed) name

    """
    return cls.SplitNameVariant(name)[0]

  @classmethod
  def GetVariant(cls, name):
    """Returns the variant the os (without the base name).

    @param name: the OS (unprocessed) name

    """
    return cls.SplitNameVariant(name)[1]

931

932
class Node(TaggableObject):
Iustin Pop's avatar
Iustin Pop committed
933
  """Config object representing a node."""
Balazs Lecz's avatar
Balazs Lecz committed
934
  __slots__ = [
935
936
937
    "name",
    "primary_ip",
    "secondary_ip",
938
    "serial_no",
939
    "master_candidate",
940
    "offline",
941
    "drained",
942
    "group",
943
944
    "master_capable",
    "vm_capable",
945
    "ndparams",
946
    ] + _TIMESTAMPS + _UUID
Iustin Pop's avatar
Iustin Pop committed
947

948
949
950
951
952
953
954
955
956
957
958
959
  def UpgradeConfig(self):
    """Fill defaults for missing configuration values.

    """
    # pylint: disable-msg=E0203
    # because these are "defined" via slots, not manually
    if self.master_capable is None:
      self.master_capable = True

    if self.vm_capable is None:
      self.vm_capable = True

960
961
962
    if self.ndparams is None:
      self.ndparams = {}

Iustin Pop's avatar
Iustin Pop committed
963

964
965
966
967
968
class NodeGroup(ConfigObject):
  """Config object representing a node group."""
  __slots__ = [
    "name",
    "members",
969
    "ndparams",
970
971
972
973
974
    ] + _TIMESTAMPS + _UUID

  def ToDict(self):
    """Custom function for nodegroup.

975
976
    This discards the members object, which gets recalculated and is only kept
    in memory.
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993

    """
    mydict = super(NodeGroup, self).ToDict()
    del mydict["members"]
    return mydict

  @classmethod
  def FromDict(cls, val):
    """Custom function for nodegroup.

    The members slot is initialized to an empty list, upon deserialization.

    """
    obj = super(NodeGroup, cls).FromDict(val)
    obj.members = []
    return obj

994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
  def UpgradeConfig(self):
    """Fill defaults for missing configuration values.

    """
    if self.ndparams is None:
      self.ndparams = {}

  def FillND(self, node):
    """Return filled out ndparams for L{object.Node}

    @type node: L{objects.Node}
    @param node: A Node object to fill
    @return a copy of the node's ndparams with defaults filled

    """
    return self.SimpleFillND(node.ndparams)

  def SimpleFillND(self, ndparams):
    """Fill a given ndparams dict with defaults.

    @type ndparams: dict
    @param ndparams: the dict to fill
    @rtype: dict
    @return: a copy of the passed in ndparams with missing keys filled
        from the cluster defaults

    """
    return FillDict(self.ndparams, ndparams)

1023

1024
class Cluster(TaggableObject):
Iustin Pop's avatar
Iustin Pop committed
1025
  """Config object representing the cluster."""
Balazs Lecz's avatar
Balazs Lecz committed
1026
  __slots__ = [
Iustin Pop's avatar
Iustin Pop committed
1027
1028
1029
    "serial_no",
    "rsahostkeypub",
    "highest_used_port",
1030
    "tcpudp_port_pool",
Iustin Pop's avatar
Iustin Pop committed
1031
1032
    "mac_prefix",
    "volume_group_name",
1033
    "reserved_lvs",
1034
    "drbd_usermode_helper",
Iustin Pop's avatar
Iustin Pop committed
1035
    "default_bridge",
1036
    "default_hypervisor",
1037
1038
1039
1040
1041
    "master_node",
    "master_ip",
    "master_netdev",
    "cluster_name",
    "file_storage_dir",
1042
    "enabled_hypervisors",
1043
    "hvparams",
1044
    "os_hvp",
1045
    "beparams",
1046
    "osparams",
1047
    "nicparams",
1048
    "ndparams",
1049
    "candidate_pool_size",
1050
    "modify_etc_hosts",
1051
    "modify_ssh_setup",
1052
    "maintain_node_health",
Balazs Lecz's avatar
Balazs Lecz committed
1053
    "uid_pool",
1054
    "default_iallocator",
1055
1056
    "hidden_os",
    "blacklisted_os",
1057
    "primary_ip_family",
1058
    "prealloc_wipe_disks",
1059
    ] + _TIMESTAMPS + _UUID
Iustin Pop's avatar
Iustin Pop committed
1060

1061
1062
1063
1064
  def UpgradeConfig(self):
    """Fill defaults for missing configuration values.

    """
Iustin Pop's avatar
Iustin Pop committed
1065
1066
    # pylint: disable-msg=E0203
    # because these are "defined" via slots, not manually
1067
1068
1069
1070
    if self.hvparams is None:
      self.hvparams = constants.HVC_DEFAULTS
    else:
      for hypervisor in self.hvparams:
Guido Trotter's avatar
Guido Trotter committed
1071
        self.hvparams[hypervisor] = FillDict(
1072
1073
            constants.HVC_DEFAULTS[hypervisor], self.hvparams[hypervisor])

1074
1075
1076
    if self.os_hvp is None:
      self.os_hvp = {}

1077
1078
1079
1080
    # osparams added before 2.2
    if self.osparams is None:
      self.osparams = {}

1081
1082
1083
    if self.ndparams is None:
      self.ndparams = constants.NDC_DEFAULTS

1084
1085
    self.beparams = UpgradeGroupedParams(self.beparams,
                                         constants.BEC_DEFAULTS)
1086
1087
1088
1089
1090
1091
    migrate_default_bridge = not self.nicparams
    self.nicparams = UpgradeGroupedParams(self.nicparams,
                                          constants.NICC_DEFAULTS)
    if migrate_default_bridge:
      self.nicparams[constants.PP_DEFAULT][constants.NIC_LINK] = \
        self.default_bridge
1092

1093
1094
1095
    if self.modify_etc_hosts is None:
      self.modify_etc_hosts = True

1096
1097
1098
    if self.modify_ssh_setup is None:
      self.modify_ssh_setup = True

1099
    # default_bridge is no longer used it 2.1. The slot is left there to
1100
1101
    # support auto-upgrading. It can be removed once we decide to deprecate
    # upgrading straight from 2.0.
1102
1103
1104
    if self.default_bridge is not None:
      self.default_bridge = None

1105
1106
    # default_hypervisor is just the first enabled one in 2.1. This slot and
    # code can be removed once upgrading straight from 2.0 is deprecated.
1107
    if self.default_hypervisor is not None:
Michael Hanselmann's avatar
Michael Hanselmann committed
1108
      self.enabled_hypervisors = ([self.default_hypervisor] +
1109
        [hvname for hvname in self.enabled_hypervisors
Michael Hanselmann's avatar
Michael Hanselmann committed
1110
         if hvname != self.default_hypervisor])
1111
1112
      self.default_hypervisor = None

1113
1114
1115
1116
    # maintain_node_health added after 2.1.1
    if self.maintain_node_health is None:
      self.maintain_node_health = False

Balazs Lecz's avatar
Balazs Lecz committed
1117
1118
1119
    if self.uid_pool is None:
      self.uid_pool = []

1120
1121
1122
    if self.default_iallocator is None:
      self.default_iallocator = ""

1123
1124
1125
1126
    # reserved_lvs added before 2.2
    if self.reserved_lvs is None:
      self.reserved_lvs = []

Iustin Pop's avatar
Iustin Pop committed
1127
    # hidden and blacklisted operating systems added before 2.2.1
1128
1129
    if self.hidden_os is None:
      self.hidden_os = []
Iustin Pop's avatar
Iustin Pop committed
1130

1131
1132
    if self.blacklisted_os is None:
      self.blacklisted_os = []
Iustin Pop's avatar
Iustin Pop committed
1133

1134
1135
1136
1137
    # primary_ip_family added before 2.3
    if self.primary_ip_family is None:
      self.primary_ip_family = AF_INET

1138
1139
1140
    if self.prealloc_wipe_disks is None:
      self.prealloc_wipe_disks = False

1141
1142
1143
1144
  def ToDict(self):
    """Custom function for cluster.

    """
1145
    mydict = super(Cluster, self).ToDict()
1146
1147
1148
1149
1150
1151
1152
1153
    mydict["tcpudp_port_pool"] = list(self.tcpudp_port_pool)
    return mydict

  @classmethod
  def FromDict(cls, val):
    """Custom function for cluster.

    """
1154
    obj = super(Cluster, cls).FromDict(val)
1155
1156
1157
1158
    if not isinstance(obj.tcpudp_port_pool, set):
      obj.tcpudp_port_pool = set(obj.tcpudp_port_pool)
    return obj

1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
  def GetHVDefaults(self, hypervisor, os_name=None, skip_keys=None):
    """Get the default hypervisor parameters for the cluster.

    @param hypervisor: the hypervisor name
    @param os_name: if specified, we'll also update the defaults for this OS
    @param skip_keys: if passed, list of keys not to use
    @return: the defaults dict

    """
    if skip_keys is None:
      skip_keys = []

    fill_stack = [self.hvparams.get(hypervisor, {})]
    if os_name is not None:
      os_hvp = self.os_hvp.get(os_name, {}).get(hypervisor, {})
      fill_stack.append(os_hvp)

    ret_dict = {}
    for o_dict in fill_stack:
      ret_dict = FillDict(ret_dict, o_dict, skip_keys=skip_keys)

    return ret_dict

1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
  def SimpleFillHV(self, hv_name, os_name, hvparams, skip_globals=False):
    """Fill a given hvparams dict with cluster defaults.

    @type hv_name: string
    @param hv_name: the hypervisor to use
    @type os_name: string
    @param os_name: the OS to use for overriding the hypervisor defaults
    @type skip_globals: boolean
    @param skip_globals: if True, the global hypervisor parameters will
        not be filled
    @rtype: dict
    @return: a copy of the given hvparams with missing keys filled from
        the cluster defaults

    """
    if skip_globals:
      skip_keys = constants.HVC_GLOBALS
    else:
      skip_keys = []

    def_dict = self.GetHVDefaults(hv_name, os_name, skip_keys=skip_keys)
    return FillDict(def_dict, hvparams, skip_keys=skip_keys)
1204

1205
  def FillHV(self, instance, skip_globals=False):
1206
    """Fill an instance's hvparams dict with cluster defaults.
1207

1208
    @type instance: L{objects.Instance}
1209
    @param instance: the instance parameter to fill
1210
1211
1212
    @type skip_globals: boolean
    @param skip_globals: if True, the global hypervisor parameters will
        not be filled
1213
1214
1215
1216
1217
    @rtype: dict
    @return: a copy of the instance's hvparams with missing keys filled from
        the cluster defaults

    """
1218
1219
    return self.SimpleFillHV(instance.hypervisor, instance.os,
                             instance.hvparams, skip_globals)
1220

1221
1222
1223
  def SimpleFillBE(self, beparams):
    """Fill a given beparams dict with cluster defaults.

1224
1225
    @type beparams: dict
    @param beparams: the dict to fill
1226
1227
1228
1229
1230
1231
    @rtype: dict
    @return: a copy of the passed in beparams with missing keys filled
        from the cluster defaults

    """
    return FillDict(self.beparams.get(constants.PP_DEFAULT, {}), beparams)
1232
1233

  def FillBE(self, instance):
1234
    """Fill an instance's beparams dict with cluster defaults.
1235

1236
    @type instance: L{objects.Instance}
1237
1238
1239
1240
1241
1242
    @param instance: the instance parameter to fill
    @rtype: dict
    @return: a copy of the instance's beparams with missing keys filled from
        the cluster defaults

    """
1243
1244
1245
1246
1247
    return self.SimpleFillBE(instance.beparams)

  def SimpleFillNIC(self, nicparams):
    """Fill a given nicparams dict with cluster defaults.

1248
1249
    @type nicparams: dict
    @param nicparams: the dict to fill
1250
1251
1252
1253
1254
1255
    @rtype: dict
    @return: a copy of the passed in nicparams with missing keys filled
        from the cluster defaults

    """
    return FillDict(self.nicparams.get(constants.PP_DEFAULT, {}), nicparams)
1256

1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
  def SimpleFillOS(self, os_name, os_params):
    """Fill an instance's osparams dict with cluster defaults.

    @type os_name: string
    @param os_name: the OS name to use
    @type os_params: dict
    @param os_params: the dict to fill with default values
    @rtype: dict
    @return: a copy of the instance's osparams with missing keys filled from
        the cluster defaults

    """
    name_only = os_name.split("+", 1)[0]
    # base OS
    result = self.osparams.get(name_only, {})
    # OS with variant
    result = FillDict(result, self.osparams.get(os_name, {}))
    # specified params
    return FillDict(result, os_params)

1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
  def FillND(self, node, nodegroup):
    """Return filled out ndparams for L{objects.NodeGroup} and L{object.Node}

    @type node: L{objects.Node}
    @param node: A Node object to fill
    @type nodegroup: L{objects.NodeGroup}
    @param nodegroup: A Node object to fill
    @return a copy of the node's ndparams with defaults filled

    """
    return self.SimpleFillND(nodegroup.FillND(node))

  def SimpleFillND(self, ndparams):
    """Fill a given ndparams dict with defaults.

    @type ndparams: dict
    @param ndparams: the dict to fill
    @rtype: dict
    @return: a copy of the passed in ndparams with missing keys filled
        from the cluster defaults

    """
    return FillDict(self.ndparams, ndparams)

1301

1302
1303
1304
1305
1306
1307
1308
1309
1310
class BlockDevStatus(ConfigObject):
  """Config object representing the status of a block device."""
  __slots__ = [
    "dev_path",
    "major",
    "minor",
    "sync_percent",
    "estimated_time",
    "is_degraded",
1311
    "ldisk_status",
1312
1313
1314
    ]


1315
1316
1317
1318
1319
1320
class ImportExportStatus(ConfigObject):
  """Config object representing the status of an import or export."""
  __slots__ = [
    "recent_output",
    "listen_port",
    "connected",
1321
1322
1323
1324
    "progress_mbytes",
    "progress_throughput",
    "progress_eta",
    "progress_percent",
1325
1326
1327
1328
1329
    "exit_status",
    "error_message",
    ] + _TIMESTAMPS


1330
1331
1332
1333
1334
class ImportExportOptions(ConfigObject):
  """Options for import/export daemon

  @ivar key_name: X509 key name (None for cluster certificate)
  @ivar ca_pem: Remote peer CA in PEM format (None for cluster certificate)
1335
  @ivar compress: Compression method (one of L{constants.IEC_ALL})
1336
  @ivar magic: Used to ensure the connection goes to the right disk
1337
  @ivar ipv6: Whether to use IPv6
1338
1339
1340
1341
1342

  """
  __slots__ = [
    "key_name",
    "ca_pem",
1343
    "compress",
1344
    "magic",
1345
    "ipv6",
1346
1347
1348
    ]


Guido Trotter's avatar
Guido Trotter committed
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
class ConfdRequest(ConfigObject):
  """Object holding a confd request.

  @ivar protocol: confd protocol version
  @ivar type: confd query type
  @ivar query: query request
  @ivar rsalt: requested reply salt

  """
  __slots__ = [
    "protocol",
    "type",
    "query",
    "rsalt",
    ]


class ConfdReply(ConfigObject):
  """Object holding a confd reply.

  @ivar protocol: confd protocol version
  @ivar status: reply status code (ok, error)
  @ivar answer: confd query reply
  @ivar serial: configuration serial number

  """
  __slots__ = [
    "protocol",
    "status",
    "answer",
    "serial",
    ]