Add support for idrac_card and lifecycle_controller attributes

Change-Id: I305976e639a406de19f23dcfb5207a25c6c311ba

dracclient/client.py

@@ -19,6 +19,7 @@
 
 from dracclient import exceptions
 from dracclient.resources import bios
+from dracclient.resources import idrac_card
 from dracclient.resources import inventory
 from dracclient.resources import job
 from dracclient.resources import lifecycle_controller
@@ -52,6 +53,8 @@ def __init__(self, host, username, password, port=443, path='/wsman',
         self._power_mgmt = bios.PowerManagement(self.client)
         self._boot_mgmt = bios.BootManagement(self.client)
         self._bios_cfg = bios.BIOSConfiguration(self.client)
+        self._lifecycle_cfg = lifecycle_controller.LCConfiguration(self.client)
+        self._idrac_cfg = idrac_card.iDRACCardConfiguration(self.client)
         self._raid_mgmt = raid.RAIDManagement(self.client)
         self._inventory_mgmt = inventory.InventoryManagement(self.client)
 
@@ -159,6 +162,33 @@ def set_bios_settings(self, settings):
         """
         return self._bios_cfg.set_bios_settings(settings)
 
+    def list_idrac_settings(self):
+        """List the iDRAC configuration settings
+
+        :returns: a dictionary with the iDRAC settings using InstanceID as the
+                  key. The attributes are either iDRACCArdEnumerableAttribute,
+                  iDRACCardStringAttribute or iDRACCardIntegerAttribute
+                  objects.
+        :raises: WSManRequestFailure on request failures
+        :raises: WSManInvalidResponse when receiving invalid response
+        :raises: DRACOperationFailed on error reported back by the DRAC
+                 interface
+        """
+        return self._idrac_cfg.list_idrac_settings()
+
+    def list_lifecycle_settings(self):
+        """List the Lifecycle Controller configuration settings
+
+        :returns: a dictionary with the Lifecycle Controller settings using its
+                  InstanceID as the key. The attributes are either
+                  LCEnumerableAttribute or LCStringAttribute objects.
+        :raises: WSManRequestFailure on request failures
+        :raises: WSManInvalidResponse when receiving invalid response
+        :raises: DRACOperationFailed on error reported back by the DRAC
+                 interface
+        """
+        return self._lifecycle_cfg.list_lifecycle_settings()
+
     def list_jobs(self, only_unfinished=False):
         """Returns a list of jobs from the job queue
 

dracclient/resources/idrac_card.py

@@ -0,0 +1,277 @@
+#
+#    Licensed under the Apache License, Version 2.0 (the "License"); you may
+#    not use this file except in compliance with the License. You may obtain
+#    a copy of the License at
+#
+#         http://www.apache.org/licenses/LICENSE-2.0
+#
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+#    WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+#    License for the specific language governing permissions and limitations
+#    under the License.
+
+from dracclient.resources import uris
+from dracclient import utils
+from dracclient import wsman
+
+
+class iDRACCardConfiguration(object):
+
+    def __init__(self, client):
+        """Creates iDRACCardManagement object
+
+        :param client: an instance of WSManClient
+        """
+        self.client = client
+
+    def list_idrac_settings(self):
+        """List the iDRACCard configuration settings
+
+        :returns: a dictionary with the iDRACCard settings using its name as
+                  the key. The attributes are either
+                  iDRACCardEnumerableAttribute, iDRACCardStringAttribute
+                  or iDRACCardIntegerAttribute objects.
+        :raises: WSManRequestFailure on request failures
+        :raises: WSManInvalidResponse when receiving invalid response
+        :raises: DRACOperationFailed on error reported back by the DRAC
+                 interface
+        """
+        result = {}
+        namespaces = [(uris.DCIM_iDRACCardEnumeration,
+                       iDRACCardEnumerableAttribute),
+                      (uris.DCIM_iDRACCardString, iDRACCardStringAttribute),
+                      (uris.DCIM_iDRACCardInteger, iDRACCardIntegerAttribute)]
+        for (namespace, attr_cls) in namespaces:
+            attribs = self._get_config(namespace, attr_cls)
+            result.update(attribs)
+        return result
+
+    def _get_config(self, resource, attr_cls):
+        result = {}
+        doc = self.client.enumerate(resource)
+
+        items = doc.find('.//{%s}Items' % wsman.NS_WSMAN)
+
+        if items:
+            for item in items:
+                attribute = attr_cls.parse(item)
+                result[attribute.instance_id] = attribute
+        return result
+
+
+class iDRACCardAttribute(object):
+    """Generic iDRACCard attribute class"""
+
+    def __init__(self, name, instance_id, current_value, pending_value,
+                 read_only, fqdd, group_id):
+        """Creates iDRACCardAttribute object
+
+        :param name: name of the iDRACCard attribute
+        :param instance_id: InstanceID of the iDRACCard attribute
+        :param current_value: current value of the iDRACCard attribute
+        :param pending_value: pending value of the iDRACCard attribute,
+                reflecting an unprocessed change (eg. config job not completed)
+        :param read_only: indicates whether this iDRACCard attribute can be
+                changed
+        :param fqdd: Fully Qualified Device Description of the iDRACCard
+                Attribute
+        :param group_id: GroupID of the iDRACCard Attribute
+        """
+        self.name = name
+        self.instance_id = instance_id
+        self.current_value = current_value
+        self.pending_value = pending_value
+        self.read_only = read_only
+        self.fqdd = fqdd
+        self.group_id = group_id
+
+    def __eq__(self, other):
+        return self.__dict__ == other.__dict__
+
+    @classmethod
+    def parse(cls, namespace, idrac_attr_xml):
+        """Parses XML and creates iDRACCardAttribute object"""
+
+        name = utils.get_wsman_resource_attr(
+            idrac_attr_xml, namespace, 'AttributeName')
+        instance_id = utils.get_wsman_resource_attr(
+            idrac_attr_xml, namespace, 'InstanceID')
+        current_value = utils.get_wsman_resource_attr(
+            idrac_attr_xml, namespace, 'CurrentValue', nullable=True)
+        pending_value = utils.get_wsman_resource_attr(
+            idrac_attr_xml, namespace, 'PendingValue', nullable=True)
+        read_only = utils.get_wsman_resource_attr(
+            idrac_attr_xml, namespace, 'IsReadOnly').lower()
+        fqdd = utils.get_wsman_resource_attr(
+            idrac_attr_xml, namespace, 'FQDD')
+        group_id = utils.get_wsman_resource_attr(
+            idrac_attr_xml, namespace, 'GroupID')
+
+        return cls(name, instance_id, current_value, pending_value,
+                   (read_only == 'true'), fqdd, group_id)
+
+
+class iDRACCardEnumerableAttribute(iDRACCardAttribute):
+    """Enumerable iDRACCard attribute class"""
+
+    namespace = uris.DCIM_iDRACCardEnumeration
+
+    def __init__(self, name, instance_id, current_value, pending_value,
+                 read_only, fqdd, group_id, possible_values):
+        """Creates iDRACCardEnumerableAttribute object
+
+        :param name: name of the iDRACCard attribute
+        :param instance_id: InstanceID of the iDRACCard attribute
+        :param current_value: current value of the iDRACCard attribute
+        :param pending_value: pending value of the iDRACCard attribute,
+                reflecting an unprocessed change (eg. config job not completed)
+        :param read_only: indicates whether this iDRACCard attribute can be
+                changed
+        :param fqdd: Fully Qualified Device Description of the iDRACCard
+                Attribute
+        :param group_id: GroupID of the iDRACCard Attribute
+        :param possible_values: list containing the allowed values for the
+                                iDRACCard attribute
+        """
+        super(iDRACCardEnumerableAttribute, self).__init__(name, instance_id,
+                                                           current_value,
+                                                           pending_value,
+                                                           read_only, fqdd,
+                                                           group_id)
+        self.possible_values = possible_values
+
+    @classmethod
+    def parse(cls, idrac_attr_xml):
+        """Parses XML and creates iDRACCardEnumerableAttribute object"""
+
+        idrac_attr = iDRACCardAttribute.parse(cls.namespace, idrac_attr_xml)
+        possible_values = [attr.text for attr
+                           in utils.find_xml(idrac_attr_xml, 'PossibleValues',
+                                             cls.namespace, find_all=True)]
+
+        return cls(idrac_attr.name, idrac_attr.instance_id,
+                   idrac_attr.current_value, idrac_attr.pending_value,
+                   idrac_attr.read_only, idrac_attr.fqdd, idrac_attr.group_id,
+                   possible_values)
+
+    def validate(self, new_value):
+        """Validates new value"""
+
+        if str(new_value) not in self.possible_values:
+            msg = ("Attribute '%(attr)s' cannot be set to value '%(val)s'."
+                   " It must be in %(possible_values)r.") % {
+                       'attr': self.name,
+                       'val': new_value,
+                       'possible_values': self.possible_values}
+            return msg
+
+
+class iDRACCardStringAttribute(iDRACCardAttribute):
+    """String iDRACCard attribute class"""
+
+    namespace = uris.DCIM_iDRACCardString
+
+    def __init__(self, name, instance_id, current_value, pending_value,
+                 read_only, fqdd, group_id, min_length, max_length):
+        """Creates iDRACCardStringAttribute object
+
+        :param name: name of the iDRACCard attribute
+        :param instance_id: InstanceID of the iDRACCard attribute
+        :param current_value: current value of the iDRACCard attribute
+        :param pending_value: pending value of the iDRACCard attribute,
+                reflecting an unprocessed change (eg. config job not completed)
+        :param read_only: indicates whether this iDRACCard attribute can be
+                changed
+        :param fqdd: Fully Qualified Device Description of the iDRACCard
+                Attribute
+        :param group_id: GroupID of the iDRACCard Attribute
+        :param min_length: minimum length of the string
+        :param max_length: maximum length of the string
+        """
+        super(iDRACCardStringAttribute, self).__init__(name, instance_id,
+                                                       current_value,
+                                                       pending_value,
+                                                       read_only, fqdd,
+                                                       group_id)
+        self.min_length = min_length
+        self.max_length = max_length
+
+    @classmethod
+    def parse(cls, idrac_attr_xml):
+        """Parses XML and creates iDRACCardStringAttribute object"""
+
+        idrac_attr = iDRACCardAttribute.parse(cls.namespace, idrac_attr_xml)
+        min_length = int(utils.get_wsman_resource_attr(
+            idrac_attr_xml, cls.namespace, 'MinLength'))
+        max_length = int(utils.get_wsman_resource_attr(
+            idrac_attr_xml, cls.namespace, 'MaxLength'))
+
+        return cls(idrac_attr.name, idrac_attr.instance_id,
+                   idrac_attr.current_value, idrac_attr.pending_value,
+                   idrac_attr.read_only, idrac_attr.fqdd, idrac_attr.group_id,
+                   min_length, max_length)
+
+
+class iDRACCardIntegerAttribute(iDRACCardAttribute):
+    """Integer iDRACCard attribute class"""
+
+    namespace = uris.DCIM_iDRACCardInteger
+
+    def __init__(self, name, instance_id, current_value, pending_value,
+                 read_only, fqdd, group_id, lower_bound, upper_bound):
+        """Creates iDRACCardIntegerAttribute object
+
+        :param name: name of the iDRACCard attribute
+        :param instance_id: InstanceID of the iDRACCard attribute
+        :param current_value: current value of the iDRACCard attribute
+        :param pending_value: pending value of the iDRACCard attribute,
+                reflecting an unprocessed change (eg. config job not completed)
+        :param read_only: indicates whether this iDRACCard attribute can be
+                changed
+        :param fqdd: Fully Qualified Device Description of the iDRACCard
+                Attribute
+        :param group_id: GroupID of the iDRACCard Attribute
+        :param lower_bound: minimum value for the iDRACCard attribute
+        :param upper_bound: maximum value for the iDRACCard attribute
+        """
+        super(iDRACCardIntegerAttribute, self).__init__(name, instance_id,
+                                                        current_value,
+                                                        pending_value,
+                                                        read_only, fqdd,
+                                                        group_id)
+        self.lower_bound = lower_bound
+        self.upper_bound = upper_bound
+
+    @classmethod
+    def parse(cls, idrac_attr_xml):
+        """Parses XML and creates iDRACCardIntegerAttribute object"""
+
+        idrac_attr = iDRACCardAttribute.parse(cls.namespace, idrac_attr_xml)
+        lower_bound = utils.get_wsman_resource_attr(
+            idrac_attr_xml, cls.namespace, 'LowerBound')
+        upper_bound = utils.get_wsman_resource_attr(
+            idrac_attr_xml, cls.namespace, 'UpperBound')
+
+        if idrac_attr.current_value:
+            idrac_attr.current_value = int(idrac_attr.current_value)
+        if idrac_attr.pending_value:
+            idrac_attr.pending_value = int(idrac_attr.pending_value)
+
+        return cls(idrac_attr.name, idrac_attr.instance_id,
+                   idrac_attr.current_value, idrac_attr.pending_value,
+                   idrac_attr.read_only, idrac_attr.fqdd, idrac_attr.group_id,
+                   int(lower_bound), int(upper_bound))
+
+    def validate(self, new_value):
+        """Validates new value"""
+
+        val = int(new_value)
+        if val < self.lower_bound or val > self.upper_bound:
+            msg = ('Attribute %(attr)s cannot be set to value %(val)d.'
+                   ' It must be between %(lower)d and %(upper)d.') % {
+                       'attr': self.name,
+                       'val': new_value,
+                       'lower': self.lower_bound,
+                       'upper': self.upper_bound}
+            return msg