ironic.drivers.modules.redfish.vendor module

Vendor Interface for Redfish drivers and its supporting methods.

class ironic.drivers.modules.redfish.vendor.RedfishVendorPassthru(*args, **kwargs)

Bases: VendorInterface

Vendor-specific interfaces for Redfish drivers.

create_subscription(task, **kwargs)

Creates a subscription.

Parameters:

• task – A TaskManager object.

• kwargs – The arguments sent with vendor passthru.

Raises:

RedfishError, if any problem occurs when trying to create a subscription.

delete_subscription(task, **kwargs)

Delete a subscription.

Parameters:

• task – A TaskManager object.

• kwargs – The arguments sent with vendor passthru.

Raises:

RedfishError, if any problem occurs when trying to delete the subscription.

eject_vmedia(task, **kwargs)

Eject a virtual media device.

Deprecated in favour of the generic API. This should be removed during the 2024.2 cycle.

Parameters:

• task – A TaskManager object.

• kwargs – The arguments sent with vendor passthru. The optional kwargs are:: ‘boot_device’: the boot device to eject

get_all_subscriptions(task, **kwargs)

Get all Subscriptions on the node

Parameters:

• task – A TaskManager object.

• kwargs – Not used.

Raises:

RedfishError, if any problem occurs when retrieving all subscriptions.

get_properties()

Return the properties of the interface.

Returns:

dictionary of <property name>:<property description> entries.

get_subscription(task, **kwargs)

Get a specific subscription on the node

Parameters:

• task – A TaskManager object.

• kwargs – The arguments sent with vendor passthru.

Raises:

RedfishError, if any problem occurs when retrieving the subscription.

validate(task, method, **kwargs)

Validate vendor-specific actions.

Checks if a valid vendor passthru method was passed and validates the parameters for the vendor passthru method.

Parameters:

• task – a TaskManager instance containing the node to act on.

• method – method to be validated.

• kwargs – kwargs containing the vendor passthru method’s parameters.

Raises:

InvalidParameterValue, if any of the parameters have invalid value.