ironic package¶
Subpackages¶
- ironic.api package
- ironic.command package
- ironic.common package- Subpackages
- Submodules- ironic.common.args module
- ironic.common.async_steps module
- ironic.common.auth_basic module
- ironic.common.automated_clean_methods module
- ironic.common.boot_devices module
- ironic.common.boot_modes module
- ironic.common.checksum_utils module
- ironic.common.cinder module
- ironic.common.components module
- ironic.common.config module
- ironic.common.console_factory module
- ironic.common.context module
- ironic.common.dhcp_factory module
- ironic.common.driver_factory module
- ironic.common.exception module- AgentAPIError
- AgentCommandTimeout
- AgentConnectionFailed
- AgentInProgress
- AllocationAlreadyExists
- AllocationDuplicateName
- AllocationFailed
- AllocationNotFound
- BIOSSettingAlreadyExists
- BIOSSettingListNotFound
- BIOSSettingNotFound
- BadRequest
- BootModeNotAllowed
- CatalogNotFound
- ChassisAlreadyExists
- ChassisNotEmpty
- ChassisNotFound
- ChildNodeLocked
- ClientSideError
- CommunicationError
- ConcurrentActionLimit
- ConductorAlreadyRegistered
- ConductorHardwareInterfacesAlreadyRegistered
- ConductorNotFound
- ConfigDriveRegenerationFailure
- ConfigInvalid
- ConfigNotFound
- Conflict
- ConsoleContainerError
- ConsoleError
- ConsoleSubprocessFailed
- DHCPLoadError
- DatabaseVersionTooOld
- DeployTemplateAlreadyExists
- DeployTemplateDuplicateName
- DeployTemplateNotFound
- DirectoryNotWritable
- DracOperationError
- DriverLoadError
- DriverNotFound
- DriverNotFoundInEntrypoint
- DriverOperationError
- Duplicate
- DuplicateName
- DuplicateNodeOnLookup
- ExclusiveLockRequired
- FailedToCleanDHCPOpts
- FailedToGetIPAddressOnPort
- FailedToGetSensorData
- FailedToParseSensorData
- FailedToUpdateDHCPOptOnPort
- FailedToUpdateMacOnPort
- FileSystemNotSupported
- FirmwareComponentAlreadyExists
- FirmwareComponentNotFound
- GlanceConnectionFailed
- HTTPForbidden
- HTTPNotFound
- HardwareInspectionFailure
- IPMIFailure
- IRMCOperationError
- IRMCSharedFileSystemNotMounted
- IloOperationError
- IloOperationNotSupported
- ImageChecksumAlgorithmFailure
- ImageChecksumError
- ImageChecksumFileReadFailure
- ImageChecksumURLNotSupported
- ImageConvertFailed
- ImageCreationFailed
- ImageDownloadFailed
- ImageHostRateLimitFailure
- ImageMatchFailure
- ImageNotAuthorized
- ImageNotFound
- ImageRefIsARedirect
- ImageRefValidationFailed
- ImageServiceAuthenticationRequired
- ImageUnacceptable
- ImageUploadFailed
- IncompatibleInterface
- IncompleteLookup
- IncorrectConfiguration
- InputFileError
- InspectionRuleAlreadyExists
- InspectionRuleExecutionFailure
- InspectionRuleNotFound
- InspectionRuleValidationFailure
- InstanceAssociated
- InstanceDeployFailure
- InstanceNotFound
- InstanceRescueFailure
- InstanceUnrescueFailure
- InsufficientDiskSpace
- InsufficientMemory
- InterfaceNotFoundInEntrypoint
- Invalid
- InvalidConductorGroup
- InvalidDatapathID
- InvalidDeployTemplate
- InvalidEndpoint
- InvalidIPAddress
- InvalidIPv4Address
- InvalidIdentity
- InvalidImage
- InvalidImageRef
- InvalidInput
- InvalidKickstartFile
- InvalidKickstartTemplate
- InvalidMAC
- InvalidName
- InvalidNodeInventory
- InvalidParameterValue
- InvalidRunbook
- InvalidState
- InvalidStateRequested
- InvalidSwitchID
- InvalidUUID
- InvalidUuidOrName
- IronicException
- KeystoneFailure
- KeystoneUnauthorized
- MACAlreadyExists
- MalformedRequestURI
- MetricsNotSupported
- MissingParameterValue
- NetworkError
- NoConsolePid
- NoDriversLoaded
- NoFreeConductorWorker
- NoFreeIPMITerminalPorts
- NoFreePhysicalPorts
- NoValidDefaultForInterface
- NoValidHost
- NodeAlreadyExists
- NodeAssociated
- NodeCleaningFailure
- NodeConsoleNotEnabled
- NodeHistoryNotFound
- NodeInMaintenance
- NodeInventoryAlreadyExists
- NodeInventoryNotFound
- NodeIsRetired
- NodeLocked
- NodeMaintenanceFailure
- NodeNotFound
- NodeNotLocked
- NodeProtected
- NodeServicingFailure
- NodeTagNotFound
- NodeTraitNotFound
- NodeVerifyFailure
- NotAcceptable
- NotAuthorized
- NotFound
- NotificationPayloadError
- NotificationSchemaKeyError
- NotificationSchemaObjectError
- OciImageNotSpecific
- OciImageTagNotFound
- OperationNotPermitted
- ParentNodeLocked
- PasswordFileFailedToCreate
- PatchError
- PathNotFound
- PortAlreadyExists
- PortDuplicateName
- PortNotFound
- PortgroupAlreadyExists
- PortgroupDuplicateName
- PortgroupMACAlreadyExists
- PortgroupNotEmpty
- PortgroupNotFound
- PortgroupPhysnetInconsistent
- PowerStateFailure
- RFBAuthHandshakeFailed
- RFBAuthNoAvailableScheme
- RedfishConnectionError
- RedfishError
- RuleActionExecutionFailure
- RuleConditionCheckFailure
- RunbookAlreadyExists
- RunbookDuplicateName
- RunbookNotFound
- SNMPFailure
- SecurityProxyNegotiationFailed
- ServiceLookupFailure
- ServiceRegistrationFailure
- ServiceUnavailable
- StorageError
- SwiftObjectNotFoundError
- SwiftObjectStillExists
- SwiftOperationError
- TemporaryFailure
- Unauthorized
- UnknownArgument
- UnknownAttribute
- UnsupportedDriverExtension
- UnsupportedHardwareFeature
- VendorPassthruException
- VifAlreadyAttached
- VifInvalidForAttach
- VifNotAttached
- VolumeConnectorAlreadyExists
- VolumeConnectorNotFound
- VolumeConnectorTypeAndIdAlreadyExists
- VolumeTargetAlreadyExists
- VolumeTargetBootIndexAlreadyExists
- VolumeTargetNotFound
 
- ironic.common.faults module
- ironic.common.fsm module
- ironic.common.hash_ring module
- ironic.common.i18n module
- ironic.common.image_publisher module
- ironic.common.image_service module
- ironic.common.images module- check_if_image_format_is_permitted()
- converted_size()
- create_boot_iso()
- create_esp_image_for_uefi()
- create_isolinux_image_for_bios()
- create_vfat_image()
- detect_file_format()
- download_size()
- fetch()
- fetch_into()
- force_raw_will_convert()
- get_image_properties()
- get_source_format()
- get_temp_url_for_glance_image()
- image_format_matches()
- image_format_permitted()
- image_show()
- image_to_raw()
- is_source_a_path()
- is_whole_disk_image()
- safety_check_image()
 
- ironic.common.indicator_states module
- ironic.common.keystone module
- ironic.common.kickstart_utils module
- ironic.common.lessee_sources module
- ironic.common.mdns module
- ironic.common.metrics module
- ironic.common.metrics_collector module
- ironic.common.metrics_statsd module
- ironic.common.metrics_utils module
- ironic.common.molds module
- ironic.common.network module
- ironic.common.neutron module- NeutronNetworkInterfaceMixin
- PHYSNET_PARAM_NAME
- add_ports_to_network()
- get_client()
- get_local_group_information()
- get_neutron_port_data()
- get_node_portmap()
- get_physnets_by_port_uuid()
- is_ovn_vtep_port()
- is_smartnic_port()
- remove_neutron_ports()
- remove_ports_from_network()
- rollback_ports()
- unbind_neutron_port()
- unbind_neutron_port_if_bound()
- update_neutron_port()
- update_port_address()
- validate_network()
- validate_port_info()
- wait_for_host_agent()
- wait_for_port_status()
 
- ironic.common.nova module
- ironic.common.oci_registry module
- ironic.common.policy module
- ironic.common.profiler module
- ironic.common.pxe_utils module- TFTPImageCache
- build_deploy_pxe_options()
- build_extra_pxe_options()
- build_instance_pxe_options()
- build_kickstart_config_options()
- build_pxe_config_options()
- build_service_pxe_config()
- cache_ramdisk_kernel()
- clean_up_pxe_config()
- clean_up_pxe_env()
- create_ipxe_boot_script()
- create_pxe_config()
- dhcp_options_for_instance()
- ensure_tree()
- get_file_path_from_label()
- get_http_url_path_from_label()
- get_image_info()
- get_instance_image_info()
- get_kernel_ramdisk_info()
- get_pxe_config_file_path()
- get_volume_pxe_options()
- is_ipxe_enabled()
- parse_driver_info()
- place_common_config()
- place_loaders_for_boot()
- prepare_instance_kickstart_config()
- prepare_instance_pxe_config()
- validate_kickstart_file()
- validate_kickstart_template()
 
- ironic.common.qemu_img module
- ironic.common.raid module
- ironic.common.release_mappings module
- ironic.common.rpc module
- ironic.common.rpc_service module
- ironic.common.service module
- ironic.common.states module- ACTIVE
- ADOPTFAIL
- ADOPTING
- AVAILABLE
- CLEANFAIL
- CLEANHOLD
- CLEANING
- CLEANWAIT
- DELETED
- DELETE_ALLOWED_STATES
- DELETING
- DEPLOY
- DEPLOYDONE
- DEPLOYFAIL
- DEPLOYHOLD
- DEPLOYING
- DEPLOYWAIT
- ENROLL
- ERROR
- FASTTRACK_LOOKUP_ALLOWED_STATES
- INSPECTFAIL
- INSPECTING
- INSPECTWAIT
- LOOKUP_ALLOWED_STATES
- MANAGEABLE
- NOSTATE
- POWER_OFF
- POWER_ON
- REBOOT
- REBUILD
- RESCUE
- RESCUEFAIL
- RESCUEWAIT
- RESCUING
- SERVICE
- SERVICEFAIL
- SERVICEHOLD
- SERVICEWAIT
- SERVICING
- SOFT_POWER_OFF
- SOFT_REBOOT
- STABLE_STATES
- STUCK_STATES_TREATED_AS_FAIL
- UNDEPLOY
- UNRESCUEFAIL
- UNRESCUING
- UNSTABLE_STATES
- UPDATE_ALLOWED_STATES
- VERBS
- VERIFYING
- on_enter()
- on_exit()
 
- ironic.common.swift module
- ironic.common.utils module- check_dir()
- create_link_without_raise()
- dd()
- execute()
- fast_track_enabled()
- file_has_content()
- file_mime_type()
- find_devices_by_hints()
- get_route_source()
- get_updated_capabilities()
- is_fips_enabled()
- is_hostname_safe()
- is_http_url()
- is_ironic_using_sqlite()
- is_loopback()
- is_memory_insufficient()
- is_regex_string_in_file()
- is_valid_datapath_id()
- is_valid_logical_name()
- is_valid_no_proxy()
- match_root_device_hints()
- mkfs()
- parse_instance_info_capabilities()
- parse_kernel_params()
- parse_root_device_hints()
- pop_node_nested_field()
- remove_large_keys()
- render_template()
- rmtree_without_raise()
- safe_rstrip()
- set_node_nested_field()
- stop_after_retries()
- tempdir()
- try_execute()
- unix_file_modification_datetime()
- unlink_without_raise()
- validate_and_normalize_datapath_id()
- validate_and_normalize_mac()
- validate_conductor_group()
- validate_network_port()
- wrap_ipv6()
- write_to_file()
 
- ironic.common.vnc module
- ironic.common.wsgi_service module
 
- Module contents
 
- ironic.conductor package- Submodules- ironic.conductor.allocations module
- ironic.conductor.base_manager module
- ironic.conductor.cleaning module
- ironic.conductor.configdrive_utils module
- ironic.conductor.deployments module
- ironic.conductor.inspection module
- ironic.conductor.manager module
- ironic.conductor.notification_utils module
- ironic.conductor.periodics module
- ironic.conductor.rpc_service module
- ironic.conductor.rpcapi module
- ironic.conductor.servicing module
- ironic.conductor.steps module
- ironic.conductor.task_manager module
- ironic.conductor.utils module- StepFlow
- abort_on_conductor_take_over()
- add_secret_token()
- agent_is_alive()
- build_configdrive()
- cleaning_error_handler()
- cleanup_after_timeout()
- cleanup_cleanwait_timeout()
- cleanup_rescuewait_timeout()
- cleanup_servicewait_timeout()
- deploying_error_handler()
- exclude_current_conductor()
- fail_on_error()
- fast_track_able()
- get_attached_vif()
- get_configdrive_image()
- get_node_next_clean_steps()
- get_node_next_deploy_steps()
- get_token_project_from_request()
- hash_password()
- is_agent_token_pregenerated()
- is_agent_token_present()
- is_agent_token_valid()
- is_fast_track()
- log_step_flow_history()
- make_salt()
- node_cache_bios_settings()
- node_cache_boot_mode()
- node_cache_firmware_components()
- node_cache_vendor()
- node_change_boot_mode()
- node_change_secure_boot()
- node_get_boot_mode()
- node_history_record()
- node_power_action()
- node_set_boot_device()
- node_set_boot_mode()
- node_update_cache()
- node_wait_for_power_state()
- notify_conductor_resume_clean()
- notify_conductor_resume_deploy()
- notify_conductor_resume_operation()
- notify_conductor_resume_service()
- power_on_node_if_needed()
- power_state_error_handler()
- power_state_for_network_configuration()
- provisioning_error_handler()
- remove_agent_url()
- remove_node_rescue_password()
- rescuing_error_handler()
- restore_power_state_if_needed()
- run_node_action()
- servicing_error_handler()
- skip_automated_cleaning()
- spawn_cleaning_error_handler()
- spawn_deploying_error_handler()
- spawn_rescue_error_handler()
- spawn_servicing_error_handler()
- store_agent_certificate()
- update_image_type()
- update_next_step_index()
- validate_instance_info_traits()
- validate_port_physnet()
- value_within_timeout()
- verifying_error_handler()
- wipe_cleaning_internal_info()
- wipe_deploy_internal_info()
- wipe_internal_info_on_power_off()
- wipe_service_internal_info()
- wipe_token_and_url()
 
- ironic.conductor.verify module
 
- Module contents
 
- Submodules
- ironic.conf package- Submodules- ironic.conf.agent module
- ironic.conf.agent_containers module
- ironic.conf.anaconda module
- ironic.conf.ansible module
- ironic.conf.api module
- ironic.conf.audit module
- ironic.conf.auth module
- ironic.conf.cinder module
- ironic.conf.conductor module
- ironic.conf.console module
- ironic.conf.database module
- ironic.conf.default module
- ironic.conf.deploy module
- ironic.conf.dhcp module
- ironic.conf.disk_utils module
- ironic.conf.dnsmasq module
- ironic.conf.drac module
- ironic.conf.exception module
- ironic.conf.fake module
- ironic.conf.glance module
- ironic.conf.healthcheck module
- ironic.conf.ilo module
- ironic.conf.inspector module
- ironic.conf.inventory module
- ironic.conf.ipmi module
- ironic.conf.irmc module
- ironic.conf.json_rpc module
- ironic.conf.mdns module
- ironic.conf.metrics module
- ironic.conf.molds module
- ironic.conf.neutron module
- ironic.conf.nova module
- ironic.conf.oci module
- ironic.conf.opts module
- ironic.conf.pxe module
- ironic.conf.redfish module
- ironic.conf.sensor_data module
- ironic.conf.service_catalog module
- ironic.conf.snmp module
- ironic.conf.swift module
- ironic.conf.types module
- ironic.conf.vnc module
 
- Module contents
 
- Submodules
- ironic.console package
- ironic.db package
- ironic.dhcp package
- ironic.drivers package- Subpackages
- Submodules- ironic.drivers.base module- ALL_INTERFACES
- BIOSInterface
- BareDriver
- BaseInterface
- BootInterface
- ConsoleInterface
- DeployInterface
- FirmwareInterface
- InspectInterface
- ManagementInterface
- NetworkInterface
- PowerInterface
- RAIDInterface
- RAID_APPLY_CONFIGURATION_ARGSINFO
- RescueInterface
- StorageInterface
- VendorInterface
- VendorMetadata
- cache_bios_settings()
- cache_firmware_components()
- clean_step()
- deploy_step()
- driver_passthru()
- passthru()
- service_step()
- verify_step()
 
- ironic.drivers.drac module
- ironic.drivers.fake_hardware module
- ironic.drivers.generic module
- ironic.drivers.hardware_type module
- ironic.drivers.ilo module
- ironic.drivers.intel_ipmi module
- ironic.drivers.ipmi module
- ironic.drivers.irmc module
- ironic.drivers.redfish module
- ironic.drivers.snmp module
- ironic.drivers.utils module- MixinVendorInterface
- add_node_capability()
- capabilities_to_dict()
- collect_ramdisk_logs()
- ensure_next_boot_device()
- force_persistent_boot()
- get_agent_iso()
- get_agent_kernel_ramdisk()
- get_field()
- get_kernel_append_params()
- get_node_capability()
- get_node_mac_addresses()
- get_ramdisk_logs_file_name()
- get_verify_ca()
- need_prepare_ramdisk()
- normalize_mac()
- power_off_and_on()
- remove_node_capability()
- store_ramdisk_logs()
 
 
- ironic.drivers.base module
- Module contents
 
- ironic.objects package- Submodules- ironic.objects.allocation module
- ironic.objects.base module
- ironic.objects.bios module
- ironic.objects.chassis module
- ironic.objects.conductor module
- ironic.objects.deploy_template module
- ironic.objects.deployment module
- ironic.objects.fields module- BooleanField
- DateTimeField
- EnumField
- FlexibleDict
- FlexibleDictField
- IntegerField
- ListOfFlexibleDictsField
- ListOfObjectsField
- ListOfStringsField
- MACAddress
- MACAddressField
- NotificationLevel
- NotificationLevelField
- NotificationStatus
- NotificationStatusField
- ObjectField
- StringAcceptsCallable
- StringField
- StringFieldThatAcceptsCallable
- UUIDField
 
- ironic.objects.firmware module
- ironic.objects.indirection module
- ironic.objects.inspection_rule module
- ironic.objects.node module
- ironic.objects.node_history module
- ironic.objects.node_inventory module
- ironic.objects.notification module
- ironic.objects.port module
- ironic.objects.portgroup module
- ironic.objects.runbook module
- ironic.objects.trait module
- ironic.objects.volume_connector module
- ironic.objects.volume_target module
 
- Module contents
 
- Submodules
- ironic.pxe_filter package
- ironic.wsgi package
