160 lines
5.5 KiB
Python
160 lines
5.5 KiB
Python
# 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.
|
|
|
|
# This is referred from Redfish standard schema.
|
|
# https://redfish.dmtf.org/schemas/Bios.v1_0_3.json
|
|
|
|
import logging
|
|
|
|
from sushy import exceptions
|
|
from sushy.resources import base
|
|
from sushy.resources import common
|
|
from sushy.resources import settings
|
|
|
|
LOG = logging.getLogger(__name__)
|
|
|
|
|
|
class ActionsField(base.CompositeField):
|
|
change_password = common.ActionField('#Bios.ChangePassword')
|
|
reset_bios = common.ActionField('#Bios.ResetBios')
|
|
|
|
|
|
class Bios(base.ResourceBase):
|
|
|
|
identity = base.Field('Id', required=True)
|
|
"""The Bios resource identity string"""
|
|
|
|
name = base.Field('Name')
|
|
"""The name of the resource"""
|
|
|
|
description = base.Field('Description')
|
|
"""Human-readable description of the BIOS resource"""
|
|
|
|
attribute_registry = base.Field('AttributeRegistry')
|
|
"""The Resource ID of the Attribute Registry
|
|
for the BIOS Attributes resource
|
|
"""
|
|
|
|
_settings = settings.SettingsField()
|
|
"""Results of last BIOS attribute update"""
|
|
|
|
attributes = base.Field('Attributes')
|
|
"""Vendor-specific key-value dict of effective BIOS attributes
|
|
|
|
Attributes cannot be updated directly.
|
|
To update use :py:func:`~set_attribute` or :py:func:`~set_attributes`
|
|
"""
|
|
|
|
_actions = ActionsField('Actions')
|
|
|
|
_pending_settings_resource = None
|
|
|
|
@property
|
|
def pending_attributes(self):
|
|
"""Pending BIOS attributes
|
|
|
|
BIOS attributes that have been comitted to the system,
|
|
but for them to take effect system restart is necessary
|
|
"""
|
|
|
|
if not self._pending_settings_resource:
|
|
self._pending_settings_resource = Bios(
|
|
self._conn,
|
|
self._settings.resource_uri,
|
|
redfish_version=self.redfish_version)
|
|
self._pending_settings_resource.refresh(force=False)
|
|
return self._pending_settings_resource.attributes
|
|
|
|
def set_attribute(self, key, value):
|
|
"""Update an attribute
|
|
|
|
Attribute update is not immediate but requires system restart.
|
|
Committed attributes can be checked at :py:attr:`~pending_attributes`
|
|
property
|
|
|
|
:param key: Attribute name
|
|
:param value: Attribute value
|
|
"""
|
|
self.set_attributes({key: value})
|
|
|
|
def set_attributes(self, value):
|
|
"""Update many attributes at once
|
|
|
|
Attribute update is not immediate but requires system restart.
|
|
Committed attributes can be checked at :py:attr:`~pending_attributes`
|
|
property
|
|
|
|
:param value: Key-value pairs for attribute name and value
|
|
"""
|
|
self._settings.commit(self._conn,
|
|
{'Attributes': value})
|
|
if self._pending_settings_resource:
|
|
self._pending_settings_resource.invalidate()
|
|
|
|
def _get_reset_bios_action_element(self):
|
|
actions = self._actions
|
|
|
|
if not actions:
|
|
raise exceptions.MissingAttributeError(attribute="Actions",
|
|
resource=self._path)
|
|
|
|
reset_bios_action = actions.reset_bios
|
|
|
|
if not reset_bios_action:
|
|
raise exceptions.MissingActionError(action='#Bios.ResetBios',
|
|
resource=self._path)
|
|
return reset_bios_action
|
|
|
|
def _get_change_password_element(self):
|
|
actions = self._actions
|
|
|
|
if not actions:
|
|
raise exceptions.MissingAttributeError(attribute="Actions",
|
|
resource=self._path)
|
|
|
|
change_password_action = actions.change_password
|
|
|
|
if not change_password_action:
|
|
raise exceptions.MissingActionError(action='#Bios.ChangePassword',
|
|
resource=self._path)
|
|
return change_password_action
|
|
|
|
def reset_bios(self):
|
|
"""Reset the BIOS attributes to default"""
|
|
|
|
target_uri = self._get_reset_bios_action_element().target_uri
|
|
|
|
LOG.debug('Resetting BIOS attributes %s ...', self.identity)
|
|
self._conn.post(target_uri)
|
|
LOG.info('BIOS attributes %s is being reset', self.identity)
|
|
|
|
def change_password(self, new_password, old_password, password_name):
|
|
"""Change BIOS password"""
|
|
|
|
target_uri = self._get_change_password_element().target_uri
|
|
|
|
LOG.debug('Changing BIOS password %s ...', self.identity)
|
|
self._conn.post(target_uri, data={'NewPassword': new_password,
|
|
'OldPassword': old_password,
|
|
'PasswordName': password_name})
|
|
LOG.info('BIOS password %s is being changed', self.identity)
|
|
|
|
def _do_refresh(self, force=False):
|
|
"""Do custom resource specific refresh activities
|
|
|
|
On refresh, all sub-resources are marked as stale, i.e.
|
|
greedy-refresh not done for them unless forced by ``force``
|
|
argument.
|
|
"""
|
|
if self._pending_settings_resource is not None:
|
|
self._pending_settings_resource.invalidate(force)
|