ironic.drivers.modules.pxe module

PXE Boot Interface

class ironic.drivers.modules.pxe.HttpBoot(*args, **kwargs)

Bases: PXEBaseMixin, BootInterface

capabilities = ['ramdisk_boot', 'pxe_boot']

http_boot_enabled = True

class ironic.drivers.modules.pxe.PXEAnacondaDeploy(*args, **kwargs)

Bases: AgentBaseMixin, HeartbeatMixin, DeployInterface

clean_up(task)

Clean up the deployment environment for the task’s node.

Unlinks TFTP and instance images and triggers image cache cleanup. Removes the TFTP configuration files for this node.

Parameters:

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

deploy(task)

Perform a deployment to the task’s node.

Perform the necessary work to deploy an image onto the specified node. This method will be called after prepare(), which may have already performed any preparatory steps, such as pre-caching some data for the node.

Parameters:

task – A TaskManager instance containing the node to act on.

Returns:

status of the deploy. One of ironic.common.states.

deploy_has_started(task)

deploy_is_done(task)

get_properties()

Return the properties of the interface.

Returns:

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

prepare(task)

Prepare the deployment environment for the task’s node.

If preparation of the deployment environment ahead of time is possible, this method should be implemented by the driver.

If implemented, this method must be idempotent. It may be called multiple times for the same node on the same conductor.

This method is called before deploy.

Parameters:

task – A TaskManager instance containing the node to act on.

reboot_to_instance(task)

Method invoked after the deployment is completed.

Parameters:

task – a TaskManager instance

should_manage_boot(task)

Whether agent boot is managed by ironic.

validate(task)

Validate the driver-specific Node deployment info.

This method validates whether the ‘driver_info’ and/or ‘instance_info’ properties of the task’s node contains the required information for this interface to function.

This method is often executed synchronously in API requests, so it should not conduct long-running checks.

Parameters:

task – A TaskManager instance containing the node to act on.

Raises:

InvalidParameterValue on malformed parameter(s)

Raises:

MissingParameterValue on missing parameter(s)

class ironic.drivers.modules.pxe.PXEBoot(*args, **kwargs)

Bases: PXEBaseMixin, BootInterface

capabilities = ['ramdisk_boot', 'pxe_boot']