ironic_inspector.pxe_filter.interface module¶
The code of the PXE boot filtering interface.
-
class
ironic_inspector.pxe_filter.interface.
FilterDriver
[source]¶ Bases:
object
The PXE boot filtering interface.
-
abstract
get_periodic_sync_task
()[source]¶ Get periodic sync task for the filter.
- Returns
a periodic task to be run in the background.
-
abstract
init_filter
()[source]¶ Initialize the internal driver state.
This method should be idempotent and may perform system-wide filter state changes. Can be synchronous.
- Returns
nothing.
-
abstract
sync
(ironic)[source]¶ Synchronize the filter with ironic and inspector.
To be called both periodically and as needed by inspector. The filter should tear down its internal state if the sync method raises in order to “propagate” filtering exception between periodic and on-demand sync call. To this end, a driver should raise from the sync call if its internal state isn’t properly initialized.
- Parameters
ironic – an ironic client instance.
- Returns
nothing.
-
abstract