ironic.objects.bios module

ironic.objects.bios module

class ironic.objects.bios.BIOSSetting(context=None, **kwargs)[source]

Bases: ironic.objects.base.IronicObject

VERSION = '1.0'
create(context=None)[source]

Create a BIOS Setting record in DB.

Parameters:context – Security context. NOTE: This should only be used internally by the indirection_api. Unfortunately, RPC requires context as the first argument, even though we don’t use it. A context should be set when instantiating the object, e.g.: BIOSSetting(context)
Raises:NodeNotFound if the node id is not found.
Raises:BIOSSettingAlreadyExists if the setting record already exists.
created_at
dbapi = <oslo_db.api.DBAPI object>
classmethod delete(context, node_id, name)[source]

Delete a BIOS Setting based on its node_id and name.

Parameters:
  • context – Security context.
  • node_id – The node id.
  • name – BIOS setting name to be deleted.
Raises:

NodeNotFound if the node id is not found.

Raises:

BIOSSettingNotFound if the bios setting name is not found.

fields = {'created_at': DateTime(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'name': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=False), 'node_id': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=False), 'updated_at': DateTime(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'value': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True)}
classmethod get(context, node_id, name)[source]

Get a BIOS Setting based on its node_id and name.

Parameters:
  • context – Security context.
  • node_id – The node id.
  • name – BIOS setting name to be retrieved.
Raises:

NodeNotFound if the node id is not found.

Raises:

BIOSSettingNotFound if the bios setting name is not found.

Returns:

A :class:’BIOSSetting’ object.

name
node_id
save(context=None)[source]

Save BIOS Setting update in DB.

Parameters:context – Security context. NOTE: This should only be used internally by the indirection_api. Unfortunately, RPC requires context as the first argument, even though we don’t use it. A context should be set when instantiating the object, e.g.: BIOSSetting(context)
Raises:NodeNotFound if the node id is not found.
Raises:BIOSSettingNotFound if the bios setting name is not found.
updated_at
value
class ironic.objects.bios.BIOSSettingList(*args, **kwargs)[source]

Bases: ironic.objects.base.IronicObjectListBase, ironic.objects.base.IronicObject

VERSION = '1.0'
classmethod create(context, node_id, settings)[source]

Create a list of BIOS Setting records in DB.

Parameters:
  • context – Security context. NOTE: This should only be used internally by the indirection_api. Unfortunately, RPC requires context as the first argument, even though we don’t use it. A context should be set when instantiating the object, e.g.: BIOSSetting(context)
  • node_id – The node id.
  • settings – A list of bios settings.
Raises:

NodeNotFound if the node id is not found.

Raises:

BIOSSettingAlreadyExists if any of the setting records already exists.

Returns:

A list of BIOSSetting objects.

created_at
dbapi = <oslo_db.api.DBAPI object>
classmethod delete(context, node_id, names)[source]

Delete BIOS Settings based on node_id and names.

Parameters:
  • context – Security context.
  • node_id – The node id.
  • names – List of BIOS setting names to be deleted.
Raises:

NodeNotFound if the node id is not found.

Raises:

BIOSSettingNotFound if any of BIOS setting fails to delete.

fields = {'created_at': DateTime(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'objects': List(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=False), 'updated_at': DateTime(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True)}
classmethod get_by_node_id(context, node_id)[source]

Get BIOS Setting based on node_id.

Parameters:
  • context – Security context.
  • node_id – The node id.
Raises:

NodeNotFound if the node id is not found.

Returns:

A list of BIOSSetting objects.

objects
classmethod save(context, node_id, settings)[source]

Save a list of BIOS Setting updates in DB.

Parameters:
  • context – Security context. NOTE: This should only be used internally by the indirection_api. Unfortunately, RPC requires context as the first argument, even though we don’t use it. A context should be set when instantiating the object, e.g.: BIOSSetting(context)
  • node_id – The node id.
  • settings – A list of bios settings.
Raises:

NodeNotFound if the node id is not found.

Raises:

BIOSSettingNotFound if any of the bios setting names is not found.

Returns:

A list of BIOSSetting objects.

classmethod sync_node_setting(context, node_id, settings)[source]

Returns lists of create/update/delete/unchanged settings.

This method sync with ‘bios_settings’ database table and sorts out four lists of create/update/delete/unchanged settings.

Parameters:
  • context – Security context.
  • node_id – The node id.
  • settings – BIOS settings to be synced.
Returns:

A 4-tuple of lists of BIOS settings to be created, updated, deleted and unchanged.

updated_at
Creative Commons Attribution 3.0 License

Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.