ironic.api.controllers.v1.driver module¶

service None

Bases: ironic.api.controllers.base.APIBase

API representation of a driver.

static Driver.convert_with_links(name, hosts, detail=False, interface_info=None)¶

Convert driver/hardware type info to an API-serializable object.

Parameters:	name – name of a hardware type. hosts – list of conductor hostnames driver is active on. detail – boolean, whether to include detailed info, such as the ‘type’ field and default/enabled interfaces fields. interface_info – optional list of dicts of hardware interface info.
Returns:	API-serializable driver object.

classmethod Driver.sample()¶

service None

Bases: ironic.api.controllers.base.APIBase

API representation of a list of drivers.

static DriverList.convert_with_links(hardware_types, detail=False)¶

Convert drivers and hardware types to an API-serializable object.

Parameters:	hardware_types – dict mapping hardware type names to conductor hostnames. detail – boolean, whether to include detailed info, such as the ‘type’ field and default/enabled interfaces fields.
Returns:	an API-serializable driver collection object.

classmethod DriverList.sample()¶

service None

Bases: pecan.rest.RestController

REST controller for driver passthru.

This controller allow vendors to expose cross-node functionality in the Ironic API. Ironic will merely relay the message from here to the specified driver, no introspection will be made in the message body.

DriverPassthruController.methods(driver_name)¶

Retrieve information about vendor methods of the given driver.

Parameters:	driver_name – name of the driver.
Returns:	dictionary with <vendor method name>:<method metadata> entries.
Raises:	DriverNotFound if the driver name is invalid or the driver cannot be loaded.

service None

Bases: pecan.rest.RestController

DriverRaidController.logical_disk_properties(driver_name)¶

Returns the logical disk properties for the driver.

Parameters:	driver_name – Name of the driver.
Returns:	A dictionary containing the properties that can be mentioned for logical disks and a textual description for them.
Raises:	UnsupportedDriverExtension if the driver doesn’t support RAID configuration.
Raises:	NotAcceptable, if requested version of the API is less than 1.12.
Raises:	DriverNotFound, if driver is not loaded on any of the conductors.

service None

Bases: pecan.rest.RestController

REST controller for Drivers.

DriversController.get_all(type=None, detail=None)[source]¶

Retrieve a list of drivers.

DriversController.get_one(driver_name)[source]¶

Retrieve a single driver.

DriversController.properties(driver_name)[source]¶

Retrieve property information of the given driver.

Parameters:	driver_name – name of the driver.
Returns:	dictionary with <property name>:<property description> entries.
Raises:	DriverNotFound (HTTP 404) if the driver name is invalid or the driver cannot be loaded.