ironic.common package

Subpackages

• ironic.common.glance_service package
  • Submodules
    • ironic.common.glance_service.image_service module
      • GlanceImageService
      • TempUrlCacheElement
      • check_image_service()
    • ironic.common.glance_service.service_utils module
      • get_conductor_project_id()
      • get_image_member_list()
      • is_glance_image()
      • is_image_active()
      • is_image_available()
      • parse_image_id()
      • translate_from_glance()
  • Module contents
• ironic.common.inspection_rules package
  • Submodules
    • ironic.common.inspection_rules.actions module
      • ActionBase
      • AddTraitAction
      • CallAPIHookAction
      • DelAttributeAction
      • DelPortAttributeAction
      • ExtendAttributeAction
      • ExtendPluginDataAction
      • ExtendPortAttributeAction
      • FailAction
      • LogAction
      • RemoveTraitAction
      • SetAttributeAction
      • SetCapabilityAction
      • SetPluginDataAction
      • SetPortAttributeAction
      • UnsetCapabilityAction
      • UnsetPluginDataAction
      • get_action()
      • update_nested_dict()
    • ironic.common.inspection_rules.base module
      • Base
    • ironic.common.inspection_rules.engine module
      • apply_actions()
      • apply_rules()
      • check_conditions()
      • get_built_in_rules()
    • ironic.common.inspection_rules.operators module
      • ContainsOperator
      • EmptyOperator
      • EqOperator
      • GeOperator
      • GtOperator
      • IsFalseOperator
      • IsNoneOperator
      • IsTrueOperator
      • LeOperator
      • LtOperator
      • MatchesOperator
      • NeOperator
      • NetOperator
      • OneOfOperator
      • OperatorBase
      • ReOperator
      • SimpleOperator
      • get_operator()
    • ironic.common.inspection_rules.utils module
      • ShallowMaskDict
      • ShallowMaskList
      • normalize_path()
      • parse_inverted_operator()
    • ironic.common.inspection_rules.validation module
      • InspectionPhase
      • actions_schema()
      • conditions_schema()
      • validate_rule()
  • Module contents
• ironic.common.json_rpc package
  • Submodules
    • ironic.common.json_rpc.client module
      • Client
    • ironic.common.json_rpc.server module
      • EmptyContext
      • InvalidParams
      • InvalidRequest
      • JsonRpcError
      • MethodNotFound
      • ParseError
      • WSGIService
  • Module contents

Submodules

• ironic.common.args module
  • and_valid()
  • boolean()
  • dict_valid()
  • host_port()
  • integer()
  • mac_address()
  • name()
  • or_valid()
  • patch()
  • schema()
  • string()
  • string_list()
  • types()
  • uuid()
  • uuid_or_name()
  • validate()
• ironic.common.async_steps module
  • get_return_state()
  • prepare_node_for_next_step()
  • remove_node_flags()
  • set_node_flags()
• ironic.common.auth_basic module
  • BasicAuthMiddleware
    • BasicAuthMiddleware.__call__()
    • BasicAuthMiddleware.format_exception()
  • auth_entry()
  • authenticate()
  • parse_entry()
  • parse_header()
  • parse_token()
  • unauthorized()
  • validate_auth_file()
• ironic.common.automated_clean_methods module
  • AUTOGENERATED
  • HYBRID
  • RUNBOOK
• ironic.common.boot_devices module
  • BIOS
  • CDROM
  • DISK
  • FLOPPY
  • ISCSIBOOT
  • PXE
  • SAFE
  • UEFIHTTP
  • VMEDIA_DEVICES
  • WANBOOT
• ironic.common.boot_modes module
  • LEGACY_BIOS
  • UEFI
• ironic.common.checksum_utils module
  • TransferHelper
    • TransferHelper.bytes_transferred
    • TransferHelper.checksum_matches
    • TransferHelper.content_length
  • compute_image_checksum()
  • get_checksum_and_algo()
  • get_checksum_from_url()
  • is_checksum_url()
  • validate_checksum()
  • validate_text_checksum()
• ironic.common.cinder module
  • attach_volumes()
  • detach_volumes()
  • get_client()
  • is_volume_attached()
  • is_volume_available()
• ironic.common.components module
  • CHASSIS
  • DISK
  • NIC
  • POWER
  • SYSTEM
• ironic.common.config module
  • parse_args()
• ironic.common.console_factory module
  • ConsoleContainerFactory
    • ConsoleContainerFactory.provider
• ironic.common.context module
  • RequestContext
    • RequestContext.FROM_DICT_EXTRA_KEYS
    • RequestContext.ensure_thread_contain_context()
    • RequestContext.from_environ()
    • RequestContext.to_dict()
    • RequestContext.to_policy_values()
  • get_admin_context()
• ironic.common.dhcp_factory module
  • DHCPFactory
    • DHCPFactory.clean_dhcp()
    • DHCPFactory.provider
    • DHCPFactory.update_dhcp()
• ironic.common.driver_factory module
  • BaseDriverFactory
    • BaseDriverFactory.get_driver()
    • BaseDriverFactory.items()
    • BaseDriverFactory.names
  • HardwareTypesFactory
  • InterfaceFactory
  • NetworkInterfaceFactory
  • StorageInterfaceFactory
  • all_interfaces()
  • build_driver_for_task()
  • check_and_update_node_interfaces()
  • default_interface()
  • enabled_supported_interfaces()
  • get_hardware_type()
  • get_interface()
  • hardware_types()
  • interfaces()
• ironic.common.exception module
  • AgentAPIError
  • AgentCommandTimeout
  • AgentConnectionFailed
  • AgentInProgress
  • AllocationAlreadyExists
  • AllocationDuplicateName
  • AllocationFailed
  • AllocationNotFound
  • BIOSSettingAlreadyExists
  • BIOSSettingListNotFound
  • BIOSSettingNotFound
  • BadRequest
  • BootModeNotAllowed
  • CatalogNotFound
  • ChassisAlreadyExists
  • ChassisNotEmpty
  • ChassisNotFound
  • ChildNodeLocked
  • ClientSideError
    • ClientSideError.faultstring
  • CommunicationError
  • ConcurrentActionLimit
  • ConductorAlreadyRegistered
  • ConductorHardwareInterfacesAlreadyRegistered
  • ConductorNotFound
  • ConfigDriveRegenerationFailure
  • ConfigInvalid
  • ConfigNotFound
  • Conflict
    • Conflict.code
  • 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
    • ImageChecksumFileReadFailure.code
  • ImageChecksumURLNotSupported
  • ImageConvertFailed
  • ImageCreationFailed
  • ImageDownloadFailed
  • ImageHostRateLimitFailure
  • ImageMatchFailure
  • ImageNotAuthorized
  • ImageNotFound
  • ImageRefIsARedirect
    • ImageRefIsARedirect.redirect_url
  • ImageRefValidationFailed
  • ImageServiceAuthenticationRequired
  • ImageUnacceptable
  • ImageUploadFailed
  • IncompatibleInterface
  • IncompleteLookup
  • IncorrectConfiguration
  • InputFileError
  • InspectionRuleAlreadyExists
  • InspectionRuleExecutionFailure
  • InspectionRuleNotFound
  • InspectionRuleValidationFailure
  • InstanceAssociated
  • InstanceDeployFailure
  • InstanceNotFound
  • InstanceRescueFailure
  • InstanceUnrescueFailure
  • InsufficientDiskSpace
  • InsufficientMemory
  • InterfaceNotFoundInEntrypoint
  • Invalid
    • Invalid.code
  • InvalidConductorGroup
  • InvalidDatapathID
  • InvalidDeployTemplate
  • InvalidEndpoint
  • InvalidIPAddress
  • InvalidIPv4Address
  • InvalidIdentity
  • InvalidImage
  • InvalidImageRef
  • InvalidInput
    • InvalidInput.faultstring
  • InvalidKickstartFile
  • InvalidKickstartTemplate
  • InvalidMAC
  • InvalidName
  • InvalidNodeInventory
  • InvalidParameterValue
  • InvalidRunbook
  • InvalidState
  • InvalidStateRequested
  • InvalidSwitchID
  • InvalidUUID
  • InvalidUuidOrName
  • IronicException
    • IronicException.code
    • IronicException.headers
    • IronicException.safe
  • KeystoneFailure
  • KeystoneUnauthorized
  • MACAlreadyExists
  • MalformedRequestURI
  • MetricsNotSupported
  • MissingParameterValue
  • NetworkError
  • NoConsolePid
  • NoDriversLoaded
  • NoFreeConductorWorker
    • NoFreeConductorWorker.code
  • NoFreeIPMITerminalPorts
  • NoFreePhysicalPorts
  • NoValidDefaultForInterface
  • NoValidHost
  • NodeAlreadyExists
  • NodeAssociated
  • NodeCleaningFailure
  • NodeConsoleNotEnabled
  • NodeHistoryNotFound
  • NodeInMaintenance
  • NodeInventoryAlreadyExists
  • NodeInventoryNotFound
  • NodeIsRetired
  • NodeLocked
  • NodeMaintenanceFailure
  • NodeNotFound
  • NodeNotLocked
  • NodeProtected
  • NodeServicingFailure
  • NodeTagNotFound
  • NodeTraitNotFound
  • NodeVerifyFailure
  • NotAcceptable
    • NotAcceptable.code
  • NotAuthorized
    • NotAuthorized.code
  • NotFound
    • NotFound.code
  • 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
    • TemporaryFailure.code
  • Unauthorized
    • Unauthorized.code
    • Unauthorized.headers
  • UnknownArgument
    • UnknownArgument.faultstring
  • UnknownAttribute
    • UnknownAttribute.add_fieldname()
    • UnknownAttribute.faultstring
  • UnsupportedDriverExtension
  • UnsupportedHardwareFeature
  • VendorPassthruException
  • VifAlreadyAttached
  • VifInvalidForAttach
  • VifNotAttached
  • VolumeConnectorAlreadyExists
  • VolumeConnectorNotFound
  • VolumeConnectorTypeAndIdAlreadyExists
  • VolumeTargetAlreadyExists
  • VolumeTargetBootIndexAlreadyExists
  • VolumeTargetNotFound
• ironic.common.faults module
  • CLEAN_FAILURE
  • POWER_FAILURE
  • RESCUE_ABORT_FAILURE
  • SERVICE_FAILURE
• ironic.common.fsm module
  • FSM
    • FSM.add_state()
    • FSM.add_transition()
    • FSM.initialize()
    • FSM.is_stable()
    • FSM.process_event()
    • FSM.target_state
• ironic.common.hash_ring module
  • HashRingManager
    • HashRingManager.get_ring()
    • HashRingManager.reset()
    • HashRingManager.ring
• ironic.common.i18n module
• ironic.common.image_publisher module
  • AbstractPublisher
    • AbstractPublisher.publish()
    • AbstractPublisher.unpublish()
  • LocalPublisher
    • LocalPublisher.publish()
    • LocalPublisher.unpublish()
  • SwiftPublisher
    • SwiftPublisher.publish()
    • SwiftPublisher.unpublish()
• ironic.common.image_service module
  • BaseImageService
    • BaseImageService.download()
    • BaseImageService.is_auth_set_needed
    • BaseImageService.show()
    • BaseImageService.transfer_verified_checksum
    • BaseImageService.validate_href()
  • FileImageService
    • FileImageService.download()
    • FileImageService.show()
    • FileImageService.validate_href()
  • HttpImageService
    • HttpImageService.download()
    • HttpImageService.gen_auth_from_conf_user_pass()
    • HttpImageService.get()
    • HttpImageService.show()
    • HttpImageService.validate_href()
    • HttpImageService.verify_basic_auth_cred_format()
  • OciImageService
    • OciImageService.download()
    • OciImageService.identify_specific_image()
    • OciImageService.is_auth_set_needed
    • OciImageService.set_image_auth()
    • OciImageService.show()
    • OciImageService.transfer_verified_checksum
    • OciImageService.validate_href()
  • get_image_service()
  • get_image_service_auth_override()
  • is_container_registry_url()
• 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
  • BLINKING
  • OFF
  • ON
  • UNKNOWN
• ironic.common.keystone module
  • add_auth_opts()
  • get_adapter()
  • get_auth()
  • get_endpoint()
  • get_service_auth()
  • get_session()
  • ks_exceptions()
  • register_auth_opts()
• ironic.common.kickstart_utils module
  • decode_and_extract_config_drive_iso()
  • prepare_config_drive()
  • read_iso9600_config_drive()
• ironic.common.lessee_sources module
  • INSTANCE
  • NONE
  • REQUEST
• ironic.common.mdns module
  • Zeroconf
    • Zeroconf.close()
    • Zeroconf.register_service()
• ironic.common.metrics module
  • Counter
    • Counter.__call__()
  • Gauge
    • Gauge.__call__()
  • MetricLogger
    • MetricLogger.counter()
    • MetricLogger.gauge()
    • MetricLogger.get_metric_name()
    • MetricLogger.get_metrics_data()
    • MetricLogger.send_counter()
    • MetricLogger.send_gauge()
    • MetricLogger.send_timer()
    • MetricLogger.timer()
  • NoopMetricLogger
  • Timer
    • Timer.__call__()
• ironic.common.metrics_collector module
  • DictCollectionMetricLogger
    • DictCollectionMetricLogger.COUNTER_TYPE
    • DictCollectionMetricLogger.GAUGE_TYPE
    • DictCollectionMetricLogger.TIMER_TYPE
    • DictCollectionMetricLogger.get_metrics_data()
• ironic.common.metrics_statsd module
  • StatsdMetricLogger
    • StatsdMetricLogger.COUNTER_TYPE
    • StatsdMetricLogger.GAUGE_TYPE
    • StatsdMetricLogger.TIMER_TYPE
• ironic.common.metrics_utils module
  • get_metrics_logger()
• ironic.common.molds module
  • get_configuration()
  • save_configuration()
• ironic.common.network module
  • get_node_vif_ids()
  • get_physnets_by_portgroup_id()
  • get_physnets_for_node()
  • get_portgroup_by_id()
  • get_ports_by_portgroup_id()
  • remove_vifs_from_node()
• ironic.common.neutron module
  • NeutronNetworkInterfaceMixin
    • NeutronNetworkInterfaceMixin.get_cleaning_network_uuid()
    • NeutronNetworkInterfaceMixin.get_inspection_network_uuid()
    • NeutronNetworkInterfaceMixin.get_provisioning_network_uuid()
    • NeutronNetworkInterfaceMixin.get_rescuing_network_uuid()
    • NeutronNetworkInterfaceMixin.get_servicing_network_uuid()
    • NeutronNetworkInterfaceMixin.validate_inspection()
  • 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
  • power_update()
• ironic.common.oci_registry module
  • MakeSession
    • MakeSession.create()
  • OciClient
    • OciClient.authenticate()
    • OciClient.download_blob_from_manifest()
    • OciClient.get_artifact_index()
    • OciClient.get_blob_url()
    • OciClient.get_cached_auth()
    • OciClient.get_manifest()
  • RegistrySessionHelper
    • RegistrySessionHelper.check_redirect_trusted()
    • RegistrySessionHelper.check_status()
    • RegistrySessionHelper.get()
    • RegistrySessionHelper.get_bearer_token()
    • RegistrySessionHelper.get_token_from_config()
    • RegistrySessionHelper.parse_www_authenticate()
• ironic.common.policy module
  • authorize()
  • check()
  • check_policy()
  • get_enforcer()
  • get_oslo_policy_enforcer()
  • init_enforcer()
  • list_policies()
• ironic.common.profiler module
  • setup()
  • trace_cls()
• 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
  • convert_image()
• ironic.common.raid module
  • SAS
  • SATA
  • SCSI
  • filter_target_raid_config()
  • get_logical_disk_properties()
  • update_raid_info()
  • validate_configuration()
• ironic.common.release_mappings module
  • get_object_versions()
• ironic.common.rpc module
  • RequestContextSerializer
    • RequestContextSerializer.deserialize_context()
    • RequestContextSerializer.deserialize_entity()
    • RequestContextSerializer.serialize_context()
    • RequestContextSerializer.serialize_entity()
  • cleanup()
  • get_allowed_exmods()
  • get_client()
  • get_sensors_notifier()
  • get_server()
  • get_transport_url()
  • get_versioned_notifier()
  • init()
  • set_defaults()
  • set_global_manager()
• ironic.common.rpc_service module
  • BaseRPCService
    • BaseRPCService.start()
• ironic.common.service module
  • ensure_rpc_transport()
  • prepare_command()
  • prepare_service()
  • process_launcher()
• 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
  • SwiftAPI
    • SwiftAPI.create_object()
    • SwiftAPI.create_object_from_data()
    • SwiftAPI.delete_object()
    • SwiftAPI.generate_temp_url()
    • SwiftAPI.get_object()
    • SwiftAPI.get_temp_url()
    • SwiftAPI.get_temp_url_key()
  • get_swift_session()
• 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
  • get_console()
  • novnc_authorize()
  • novnc_unauthorize()
  • novnc_validate()
  • token_valid_until()
• ironic.common.wsgi_service module
  • BaseWSGIService
    • BaseWSGIService.reset()
    • BaseWSGIService.start()
    • BaseWSGIService.stop()
    • BaseWSGIService.wait()
  • WSGIService
  • validate_cert_paths()

Module contents