ironic.drivers package

Subpackages

• ironic.drivers.modules package
  • Subpackages
    • ironic.drivers.modules.ansible package
      • Submodules
      • Module contents
    • ironic.drivers.modules.drac package
      • Submodules
      • Module contents
    • ironic.drivers.modules.ibmc package
      • Submodules
      • Module contents
    • ironic.drivers.modules.ilo package
      • Submodules
      • Module contents
    • ironic.drivers.modules.intel_ipmi package
      • Submodules
      • Module contents
    • ironic.drivers.modules.irmc package
      • Submodules
      • Module contents
    • ironic.drivers.modules.network package
      • Submodules
      • Module contents
    • ironic.drivers.modules.redfish package
      • Submodules
      • Module contents
    • ironic.drivers.modules.storage package
      • Submodules
      • Module contents
    • ironic.drivers.modules.xclarity package
      • Submodules
      • Module contents
  • Submodules
    • ironic.drivers.modules.agent module
      • AgentDeploy
      • AgentDeployMixin
      • AgentRAID
      • AgentRescue
      • check_image_size()
      • validate_http_provisioning_configuration()
      • validate_image_proxies()
    • ironic.drivers.modules.agent_base module
      • AgentBaseMixin
      • AgentDeployMixin
      • AgentOobStepsMixin
      • HeartbeatMixin
      • execute_clean_step()
      • execute_step()
      • find_step()
      • get_steps()
      • log_and_raise_deployment_error()
      • post_clean_step_hook()
      • post_deploy_step_hook()
    • ironic.drivers.modules.agent_client module
      • AgentClient
      • get_client()
      • get_command_error()
    • ironic.drivers.modules.agent_power module
      • AgentPower
    • ironic.drivers.modules.boot_mode_utils module
      • configure_secure_boot_if_needed()
      • deconfigure_secure_boot_if_needed()
      • get_boot_mode()
      • get_boot_mode_for_deploy()
      • is_secure_boot_requested()
      • is_trusted_boot_requested()
      • sync_boot_mode()
    • ironic.drivers.modules.console_utils module
      • acquire_port()
      • get_shellinabox_console_url()
      • get_socat_console_url()
      • make_persistent_password_file()
      • release_port()
      • start_shellinabox_console()
      • start_socat_console()
      • stop_shellinabox_console()
      • stop_socat_console()
    • ironic.drivers.modules.deploy_utils module
      • InstanceImageCache
      • agent_add_clean_params()
      • build_agent_options()
      • build_instance_info_for_deploy()
      • cache_instance_image()
      • check_for_missing_params()
      • check_interface_capability()
      • compute_image_checksum()
      • destroy_http_instance_images()
      • destroy_images()
      • direct_deploy_should_convert_raw_image()
      • fetch_images()
      • get_async_step_return_state()
      • get_boot_option()
      • get_default_boot_option()
      • get_disk_label()
      • get_image_download_source()
      • get_image_instance_info()
      • get_ipxe_boot_file()
      • get_ipxe_config_template()
      • get_ironic_api_url()
      • get_pxe_boot_file()
      • get_pxe_config_template()
      • get_remote_boot_volume()
      • get_root_device_for_deploy()
      • get_single_nic_with_vif_port_id()
      • is_anaconda_deploy()
      • is_iscsi_boot()
      • is_ramdisk_deploy()
      • is_software_raid()
      • parse_instance_info()
      • populate_storage_driver_internal_info()
      • prepare_inband_cleaning()
      • remove_http_instance_symlink()
      • rescue_or_deploy_mode()
      • set_async_step_flags()
      • set_failed_state()
      • switch_pxe_config()
      • tear_down_inband_cleaning()
      • tear_down_storage_configuration()
      • try_set_boot_device()
      • validate_capabilities()
      • validate_image_properties()
    • ironic.drivers.modules.fake module
      • FakeBIOS
      • FakeBoot
      • FakeConsole
      • FakeDeploy
      • FakeInspect
      • FakeManagement
      • FakePower
      • FakeRAID
      • FakeRescue
      • FakeStorage
      • FakeVendorA
      • FakeVendorB
    • ironic.drivers.modules.image_cache module
      • ImageCache
      • clean_up_caches()
      • cleanup()
    • ironic.drivers.modules.image_utils module
      • ImageHandler
      • cleanup_disk_image()
      • cleanup_floppy_image()
      • cleanup_iso_image()
      • override_api_url()
      • prepare_boot_iso()
      • prepare_configdrive_image()
      • prepare_deploy_iso()
      • prepare_disk_image()
      • prepare_floppy_image()
    • ironic.drivers.modules.inspect_utils module
      • create_ports_if_not_exist()
    • ironic.drivers.modules.inspector module
      • Inspector
    • ironic.drivers.modules.ipmitool module
      • IPMIConsole
      • IPMIManagement
      • IPMIPower
      • IPMIShellinaboxConsole
      • IPMISocatConsole
      • VendorPassthru
      • check_cipher_suite_errors()
      • choose_cipher_suite()
      • dump_sdr()
      • send_raw()
      • update_cipher_suite_cmd()
    • ironic.drivers.modules.ipxe module
      • iPXEBoot
    • ironic.drivers.modules.iscsi_deploy module
      • ISCSIDeploy
      • check_file_system_for_iscsi_device()
      • check_image_size()
      • continue_deploy()
      • delete_iscsi()
      • deploy_disk_image()
      • deploy_partition_image()
      • discovery()
      • do_agent_iscsi_deploy()
      • force_iscsi_lun_update()
      • get_deploy_info()
      • login_iscsi()
      • logout_iscsi()
      • validate()
      • verify_iscsi_connection()
    • ironic.drivers.modules.noop module
      • FailMixin
      • NoBIOS
      • NoConsole
      • NoInspect
      • NoRAID
      • NoRescue
      • NoVendor
    • ironic.drivers.modules.noop_mgmt module
      • NoopManagement
    • ironic.drivers.modules.pxe module
      • PXEAnacondaDeploy
      • PXEBoot
      • PXERamdiskDeploy
    • ironic.drivers.modules.pxe_base module
      • PXEBaseMixin
    • ironic.drivers.modules.snmp module
      • SNMPClient
      • SNMPDriverAPCMasterSwitch
      • SNMPDriverAPCMasterSwitchPlus
      • SNMPDriverAPCRackPDU
      • SNMPDriverAten
      • SNMPDriverAuto
      • SNMPDriverBase
      • SNMPDriverBaytechMRP27
      • SNMPDriverCyberPower
      • SNMPDriverEatonPower
      • SNMPDriverSimple
      • SNMPDriverTeltronix
      • SNMPPower
      • memoize()
      • retry_on_outdated_cache()
  • Module contents

Submodules

• ironic.drivers.base module
  • ALL_INTERFACES
  • BIOSInterface
    • BIOSInterface.apply_configuration()
    • BIOSInterface.cache_bios_settings()
    • BIOSInterface.factory_reset()
    • BIOSInterface.interface_type
  • BareDriver
    • BareDriver.all_interfaces
    • BareDriver.bios
    • BareDriver.boot
    • BareDriver.console
    • BareDriver.core_interfaces
    • BareDriver.deploy
    • BareDriver.get_properties()
    • BareDriver.inspect
    • BareDriver.management
    • BareDriver.network
    • BareDriver.non_vendor_interfaces
    • BareDriver.optional_interfaces
    • BareDriver.power
    • BareDriver.raid
    • BareDriver.rescue
    • BareDriver.storage
    • BareDriver.vendor
  • BaseInterface
    • BaseInterface.execute_clean_step()
    • BaseInterface.execute_deploy_step()
    • BaseInterface.get_clean_steps()
    • BaseInterface.get_deploy_steps()
    • BaseInterface.get_properties()
    • BaseInterface.interface_type
    • BaseInterface.supported
    • BaseInterface.validate()
  • BootInterface
    • BootInterface.capabilities
    • BootInterface.clean_up_instance()
    • BootInterface.clean_up_ramdisk()
    • BootInterface.interface_type
    • BootInterface.prepare_instance()
    • BootInterface.prepare_ramdisk()
    • BootInterface.validate_inspection()
    • BootInterface.validate_rescue()
  • ConsoleInterface
    • ConsoleInterface.get_console()
    • ConsoleInterface.interface_type
    • ConsoleInterface.start_console()
    • ConsoleInterface.stop_console()
  • DeployInterface
    • DeployInterface.clean_up()
    • DeployInterface.deploy()
    • DeployInterface.heartbeat()
    • DeployInterface.interface_type
    • DeployInterface.prepare()
    • DeployInterface.prepare_cleaning()
    • DeployInterface.take_over()
    • DeployInterface.tear_down()
    • DeployInterface.tear_down_cleaning()
  • InspectInterface
    • InspectInterface.ESSENTIAL_PROPERTIES
    • InspectInterface.abort()
    • InspectInterface.inspect_hardware()
    • InspectInterface.interface_type
  • ManagementInterface
    • ManagementInterface.detect_vendor()
    • ManagementInterface.get_boot_device()
    • ManagementInterface.get_boot_mode()
    • ManagementInterface.get_indicator_state()
    • ManagementInterface.get_mac_addresses()
    • ManagementInterface.get_secure_boot_state()
    • ManagementInterface.get_sensors_data()
    • ManagementInterface.get_supported_boot_devices()
    • ManagementInterface.get_supported_boot_modes()
    • ManagementInterface.get_supported_indicators()
    • ManagementInterface.inject_nmi()
    • ManagementInterface.interface_type
    • ManagementInterface.set_boot_device()
    • ManagementInterface.set_boot_mode()
    • ManagementInterface.set_indicator_state()
    • ManagementInterface.set_secure_boot_state()
  • NetworkInterface
    • NetworkInterface.add_cleaning_network()
    • NetworkInterface.add_inspection_network()
    • NetworkInterface.add_provisioning_network()
    • NetworkInterface.add_rescuing_network()
    • NetworkInterface.configure_tenant_networks()
    • NetworkInterface.get_current_vif()
    • NetworkInterface.get_node_network_data()
    • NetworkInterface.get_properties()
    • NetworkInterface.interface_type
    • NetworkInterface.need_power_on()
    • NetworkInterface.port_changed()
    • NetworkInterface.portgroup_changed()
    • NetworkInterface.remove_cleaning_network()
    • NetworkInterface.remove_inspection_network()
    • NetworkInterface.remove_provisioning_network()
    • NetworkInterface.remove_rescuing_network()
    • NetworkInterface.unconfigure_tenant_networks()
    • NetworkInterface.validate()
    • NetworkInterface.validate_inspection()
    • NetworkInterface.validate_rescue()
    • NetworkInterface.vif_attach()
    • NetworkInterface.vif_detach()
    • NetworkInterface.vif_list()
  • PowerInterface
    • PowerInterface.get_power_state()
    • PowerInterface.get_supported_power_states()
    • PowerInterface.interface_type
    • PowerInterface.reboot()
    • PowerInterface.set_power_state()
    • PowerInterface.supports_power_sync()
  • RAIDInterface
    • RAIDInterface.apply_configuration()
    • RAIDInterface.create_configuration()
    • RAIDInterface.delete_configuration()
    • RAIDInterface.get_logical_disk_properties()
    • RAIDInterface.get_properties()
    • RAIDInterface.interface_type
    • RAIDInterface.validate()
    • RAIDInterface.validate_raid_config()
  • RAID_APPLY_CONFIGURATION_ARGSINFO
  • RescueInterface
    • RescueInterface.clean_up()
    • RescueInterface.interface_type
    • RescueInterface.rescue()
    • RescueInterface.unrescue()
  • StorageInterface
    • StorageInterface.attach_volumes()
    • StorageInterface.detach_volumes()
    • StorageInterface.interface_type
    • StorageInterface.should_write_image()
  • VendorInterface
    • VendorInterface.driver_validate()
    • VendorInterface.interface_type
    • VendorInterface.validate()
  • VendorMetadata
    • VendorMetadata.metadata
    • VendorMetadata.method
  • cache_bios_settings()
  • clean_step()
  • deploy_step()
  • driver_passthru()
  • passthru()
• ironic.drivers.drac module
  • IDRACHardware
    • IDRACHardware.supported_bios_interfaces
    • IDRACHardware.supported_boot_interfaces
    • IDRACHardware.supported_inspect_interfaces
    • IDRACHardware.supported_management_interfaces
    • IDRACHardware.supported_power_interfaces
    • IDRACHardware.supported_raid_interfaces
    • IDRACHardware.supported_vendor_interfaces
• ironic.drivers.fake_hardware module
  • FakeHardware
    • FakeHardware.supported_bios_interfaces
    • FakeHardware.supported_boot_interfaces
    • FakeHardware.supported_console_interfaces
    • FakeHardware.supported_deploy_interfaces
    • FakeHardware.supported_inspect_interfaces
    • FakeHardware.supported_management_interfaces
    • FakeHardware.supported_network_interfaces
    • FakeHardware.supported_power_interfaces
    • FakeHardware.supported_raid_interfaces
    • FakeHardware.supported_rescue_interfaces
    • FakeHardware.supported_storage_interfaces
    • FakeHardware.supported_vendor_interfaces
• ironic.drivers.generic module
  • GenericHardware
    • GenericHardware.supported_boot_interfaces
    • GenericHardware.supported_deploy_interfaces
    • GenericHardware.supported_inspect_interfaces
    • GenericHardware.supported_network_interfaces
    • GenericHardware.supported_raid_interfaces
    • GenericHardware.supported_rescue_interfaces
    • GenericHardware.supported_storage_interfaces
  • ManualManagementHardware
    • ManualManagementHardware.supported_management_interfaces
    • ManualManagementHardware.supported_power_interfaces
    • ManualManagementHardware.supported_vendor_interfaces
• ironic.drivers.hardware_type module
  • AbstractHardwareType
    • AbstractHardwareType.get_properties()
    • AbstractHardwareType.supported
    • AbstractHardwareType.supported_bios_interfaces
    • AbstractHardwareType.supported_boot_interfaces
    • AbstractHardwareType.supported_console_interfaces
    • AbstractHardwareType.supported_deploy_interfaces
    • AbstractHardwareType.supported_inspect_interfaces
    • AbstractHardwareType.supported_management_interfaces
    • AbstractHardwareType.supported_network_interfaces
    • AbstractHardwareType.supported_power_interfaces
    • AbstractHardwareType.supported_raid_interfaces
    • AbstractHardwareType.supported_rescue_interfaces
    • AbstractHardwareType.supported_storage_interfaces
    • AbstractHardwareType.supported_vendor_interfaces
• ironic.drivers.ibmc module
  • IBMCHardware
    • IBMCHardware.supported_management_interfaces
    • IBMCHardware.supported_power_interfaces
    • IBMCHardware.supported_raid_interfaces
    • IBMCHardware.supported_vendor_interfaces
• ironic.drivers.ilo module
  • Ilo5Hardware
    • Ilo5Hardware.supported_boot_interfaces
    • Ilo5Hardware.supported_management_interfaces
    • Ilo5Hardware.supported_raid_interfaces
  • IloHardware
    • IloHardware.supported_bios_interfaces
    • IloHardware.supported_boot_interfaces
    • IloHardware.supported_console_interfaces
    • IloHardware.supported_inspect_interfaces
    • IloHardware.supported_management_interfaces
    • IloHardware.supported_power_interfaces
    • IloHardware.supported_vendor_interfaces
• ironic.drivers.intel_ipmi module
  • IntelIPMIHardware
    • IntelIPMIHardware.supported_management_interfaces
• ironic.drivers.ipmi module
  • IPMIHardware
    • IPMIHardware.supported_console_interfaces
    • IPMIHardware.supported_management_interfaces
    • IPMIHardware.supported_power_interfaces
    • IPMIHardware.supported_vendor_interfaces
• ironic.drivers.irmc module
  • IRMCHardware
    • IRMCHardware.supported_bios_interfaces
    • IRMCHardware.supported_boot_interfaces
    • IRMCHardware.supported_console_interfaces
    • IRMCHardware.supported_inspect_interfaces
    • IRMCHardware.supported_management_interfaces
    • IRMCHardware.supported_power_interfaces
    • IRMCHardware.supported_raid_interfaces
• ironic.drivers.redfish module
  • RedfishHardware
    • RedfishHardware.supported_bios_interfaces
    • RedfishHardware.supported_boot_interfaces
    • RedfishHardware.supported_inspect_interfaces
    • RedfishHardware.supported_management_interfaces
    • RedfishHardware.supported_power_interfaces
    • RedfishHardware.supported_raid_interfaces
    • RedfishHardware.supported_vendor_interfaces
• ironic.drivers.snmp module
  • SNMPHardware
    • SNMPHardware.supported_management_interfaces
    • SNMPHardware.supported_power_interfaces
• ironic.drivers.utils module
  • MixinVendorInterface
    • MixinVendorInterface.get_properties()
    • MixinVendorInterface.validate()
  • add_node_capability()
  • capabilities_to_dict()
  • collect_ramdisk_logs()
  • ensure_next_boot_device()
  • force_persistent_boot()
  • get_node_capability()
  • get_node_mac_addresses()
  • get_ramdisk_logs_file_name()
  • need_prepare_ramdisk()
  • normalize_mac()
  • store_ramdisk_logs()
• ironic.drivers.xclarity module
  • XClarityHardware
    • XClarityHardware.supported_management_interfaces
    • XClarityHardware.supported_power_interfaces

Module contents