ironic.drivers.modules.pxe_base module¶
Base PXE Interface Methods
- class ironic.drivers.modules.pxe_base.PXEBaseMixin[source]¶
Bases:
object- clean_up_instance(task)[source]¶
Cleans up the boot of instance.
This method cleans up the environment that was setup for booting the instance. It unlinks the instance kernel/ramdisk in node’s directory in tftproot and removes the PXE config.
- Parameters:
task – a task from TaskManager.
- Returns:
None
- clean_up_ramdisk(task)[source]¶
Cleans up the boot of ironic ramdisk.
This method cleans up the PXE environment that was setup for booting the deploy or rescue ramdisk. It unlinks the deploy/rescue kernel/ramdisk in the node’s directory in tftproot and removes it’s PXE config.
- Parameters:
task – a task from TaskManager.
mode – Label indicating a deploy or rescue operation was carried out on the node. Supported values are ‘deploy’ and ‘rescue’. Defaults to ‘deploy’, indicating deploy operation was carried out.
- Returns:
None
- get_properties()[source]¶
Return the properties of the interface.
- Returns:
dictionary of <property name>:<property description> entries.
- http_boot_enabled = False¶
- ipxe_enabled = False¶
- prepare_instance(task)[source]¶
Prepares the boot of instance.
This method prepares the boot of the instance after reading relevant information from the node’s instance_info. In case of netboot, it updates the dhcp entries and switches the PXE config. In case of localboot, it cleans up the PXE config.
- Parameters:
task – a task from TaskManager.
- Returns:
None
- prepare_ramdisk(task, ramdisk_params)[source]¶
Prepares the boot of Ironic ramdisk using PXE.
This method prepares the boot of the deploy or rescue kernel/ramdisk after reading relevant information from the node’s driver_info and instance_info.
- Parameters:
task – a task from TaskManager.
ramdisk_params – the parameters to be passed to the ramdisk. pxe driver passes these parameters as kernel command-line arguments.
- Returns:
None
- Raises:
MissingParameterValue, if some information is missing in node’s driver_info or instance_info.
- Raises:
InvalidParameterValue, if some information provided is invalid.
- Raises:
IronicException, if some power or set boot boot device operation failed on the node.
- validate(task)[source]¶
Validate the PXE-specific info for booting deploy/instance images.
This method validates the PXE-specific info for booting the ramdisk and instance on the node. If invalid, raises an exception; otherwise returns None.
- Parameters:
task – a task from TaskManager.
- Returns:
None
- Raises:
InvalidParameterValue, if some parameters are invalid.
- Raises:
MissingParameterValue, if some required parameters are missing.
