The ironic.drivers.modules.drac.vendor_passthru
Module¶
DRAC vendor-passthru interface
-
class
ironic.drivers.modules.drac.vendor_passthru.
DracVendorPassthru
[source]¶ Bases:
ironic.drivers.base.VendorInterface
Interface for DRAC specific methods.
-
abandon_bios_config
(*args, **kwargs)[source]¶ Abandon a BIOS configuration job.
This method is used to abandon a BIOS configuration previously submitted through set_bios_config().
Parameters: - task – a TaskManager instance containing the node to act on.
- kwargs – not used.
Raises: DracOperationError on an error from python-dracclient.
-
commit_bios_config
(*args, **kwargs)[source]¶ Commit a BIOS configuration job.
This method is used to commit a BIOS configuration job. submitted through set_bios_config().
Parameters: - task – a TaskManager instance containing the node to act on.
- reboot – indicates whether a reboot job should be automatically created with the config job.
- kwargs – not used.
Raises: DracOperationError on an error from python-dracclient.
Returns: A dictionary containing the
job_id
key with the id of the newly created config job, and thereboot_required
key indicating whether the node needs to be rebooted to start the config job.
-
get_bios_config
(*args, **kwargs)[source]¶ Get the BIOS configuration.
This method is used to retrieve the BIOS settings from a node.
Parameters: - task – a TaskManager instance containing the node to act on.
- kwargs – not used.
Raises: DracOperationError on an error from python-dracclient.
Returns: a dictionary containing BIOS settings.
-
list_unfinished_jobs
(*args, **kwargs)[source]¶ List unfinished config jobs of the node.
Parameters: - task – a TaskManager instance containing the node to act on.
- kwargs – not used.
Returns: a dictionary containing the
unfinished_jobs
key; this key points to a list of dicts, with each dict representing a Job object.Raises: DracOperationError on an error from python-dracclient.
-
set_bios_config
(*args, **kwargs)[source]¶ Change BIOS settings.
This method is used to change the BIOS settings on a node.
Parameters: - task – a TaskManager instance containing the node to act on.
- kwargs – a dictionary of {‘AttributeName’: ‘NewValue’}
Raises: DracOperationError on an error from python-dracclient.
Returns: A dictionary containing the
commit_required
key with a Boolean value indicating whether commit_bios_config() needs to be called to make the changes.
-
validate
(*args, **kwargs)[source]¶ Validate the driver-specific info supplied.
This method validates whether the ‘driver_info’ property of the supplied node contains the required information for this driver to manage the power state of the node.
Parameters: - task – a TaskManager instance containing the node to act on.
- kwargs – not used.
Raises: InvalidParameterValue if required driver_info attribute is missing or invalid on the node.
-