ironic_python_agent package

Subpackages

• ironic_python_agent.api package
  • Submodules
    • ironic_python_agent.api.app module
      • Application
      • Request
      • format_exception()
      • jsonify()
      • make_link()
      • version()
  • Module contents
• ironic_python_agent.cmd package
  • Submodules
    • ironic_python_agent.cmd.agent module
      • run()
    • ironic_python_agent.cmd.inspect module
      • run()
  • Module contents
• ironic_python_agent.extensions package
  • Submodules
    • ironic_python_agent.extensions.base module
      • AgentCommandStatus
      • AsyncCommandResult
      • BaseAgentExtension
      • BaseCommandResult
      • ExecuteCommandMixin
      • SyncCommandResult
      • async_command()
      • get_extension()
      • init_ext_manager()
      • sync_command()
    • ironic_python_agent.extensions.clean module
      • CleanExtension
    • ironic_python_agent.extensions.deploy module
      • DeployExtension
    • ironic_python_agent.extensions.flow module
      • FlowExtension
    • ironic_python_agent.extensions.image module
      • ImageExtension
    • ironic_python_agent.extensions.log module
      • LogExtension
    • ironic_python_agent.extensions.poll module
      • PollExtension
    • ironic_python_agent.extensions.rescue module
      • RescueExtension
    • ironic_python_agent.extensions.service module
      • ServiceExtension
    • ironic_python_agent.extensions.standby module
      • ImageDownload
      • StandbyExtension
      • SuppliedAuth
      • check_md5_enabled()
    • ironic_python_agent.extensions.system module
      • SystemExtension
  • Module contents
• ironic_python_agent.hardware_managers package
  • Submodules
    • ironic_python_agent.hardware_managers.cna module
      • IntelCnaHardwareManager
    • ironic_python_agent.hardware_managers.container module
      • ContainerHardwareManager
    • ironic_python_agent.hardware_managers.mlnx module
      • MellanoxDeviceHardwareManager
  • Module contents
• ironic_python_agent.metrics_lib package
  • Submodules
    • ironic_python_agent.metrics_lib.metrics module
      • Counter
      • Gauge
      • MetricLogger
      • NoopMetricLogger
      • Timer
    • ironic_python_agent.metrics_lib.metrics_collector module
      • DictCollectionMetricLogger
    • ironic_python_agent.metrics_lib.metrics_statsd module
      • StatsdMetricLogger
      • list_opts()
    • ironic_python_agent.metrics_lib.metrics_utils module
      • get_metrics_logger()
  • Module contents

Submodules

• ironic_python_agent.agent module
  • Host
    • Host.hostname
    • Host.port
  • IronicPythonAgent
    • IronicPythonAgent.force_heartbeat()
    • IronicPythonAgent.from_config()
    • IronicPythonAgent.get_command_result()
    • IronicPythonAgent.get_node_uuid()
    • IronicPythonAgent.get_status()
    • IronicPythonAgent.list_command_results()
    • IronicPythonAgent.process_lookup_data()
    • IronicPythonAgent.run()
    • IronicPythonAgent.serve_ipa_api()
    • IronicPythonAgent.set_agent_advertise_addr()
    • IronicPythonAgent.validate_agent_token()
  • IronicPythonAgentHeartbeater
    • IronicPythonAgentHeartbeater.do_heartbeat()
    • IronicPythonAgentHeartbeater.force_heartbeat()
    • IronicPythonAgentHeartbeater.max_error_jitter_multiplier
    • IronicPythonAgentHeartbeater.max_jitter_multiplier
    • IronicPythonAgentHeartbeater.min_error_jitter_multiplier
    • IronicPythonAgentHeartbeater.min_heartbeat_interval
    • IronicPythonAgentHeartbeater.min_jitter_multiplier
    • IronicPythonAgentHeartbeater.run()
    • IronicPythonAgentHeartbeater.stop()
  • IronicPythonAgentStatus
    • IronicPythonAgentStatus.serializable_fields
• ironic_python_agent.burnin module
  • fio_disk()
  • fio_network()
  • gpu_burn()
  • stress_ng()
  • stress_ng_cpu()
  • stress_ng_vm()
• ironic_python_agent.config module
  • list_opts()
  • override()
  • populate_config()
• ironic_python_agent.device_hints module
  • find_devices_by_hints()
  • match_root_device_hints()
  • parse_root_device_hints()
• ironic_python_agent.disk_partitioner module
  • DiskPartitioner
    • DiskPartitioner.add_partition()
    • DiskPartitioner.commit()
    • DiskPartitioner.get_partitions()
• ironic_python_agent.disk_utils module
  • block_uuid()
  • count_mbr_partitions()
  • dd()
  • destroy_disk_metadata()
  • find_efi_partition()
  • fix_gpt_partition()
  • get_and_validate_image_format()
  • get_dev_byte_size()
  • get_dev_sector_size()
  • get_device_information()
  • get_disk_identifier()
  • get_partition_table_type()
  • is_block_device()
  • is_last_char_digit()
  • list_partitions()
  • make_partitions()
  • partition_index_to_path()
  • partprobe()
  • populate_image()
  • trigger_device_rescan()
  • udev_settle()
  • wait_for_disk_to_become_available()
• ironic_python_agent.dmi_inspector module
  • collect_dmidecode_info()
  • parse_dmi()
• ironic_python_agent.efi_utils module
  • add_boot_record()
  • clean_boot_records()
  • get_boot_records()
  • get_partition_path_by_number()
  • manage_uefi()
  • remove_boot_record()
• ironic_python_agent.encoding module
  • RESTJSONEncoder
    • RESTJSONEncoder.default()
    • RESTJSONEncoder.encode()
  • Serializable
    • Serializable.serializable_fields
    • Serializable.serialize()
  • SerializableComparable
• ironic_python_agent.errors module
  • AgentIsBusy
    • AgentIsBusy.message
    • AgentIsBusy.status_code
  • BlockDeviceEraseError
    • BlockDeviceEraseError.message
  • BlockDeviceError
    • BlockDeviceError.message
  • CleaningError
    • CleaningError.message
  • ClockSyncError
    • ClockSyncError.message
  • CommandExecutionError
    • CommandExecutionError.message
  • DeploymentError
    • DeploymentError.message
  • DeviceNotFound
    • DeviceNotFound.message
  • ExtensionError
  • FileSystemNotSupported
  • HardwareManagerConfigurationError
    • HardwareManagerConfigurationError.message
  • HardwareManagerMethodNotFound
    • HardwareManagerMethodNotFound.message
  • HardwareManagerNotFound
    • HardwareManagerNotFound.message
  • HeartbeatConflictError
    • HeartbeatConflictError.message
  • HeartbeatConnectionError
    • HeartbeatConnectionError.message
  • HeartbeatError
    • HeartbeatError.message
  • ImageChecksumError
    • ImageChecksumError.details_str
    • ImageChecksumError.message
  • ImageDownloadError
    • ImageDownloadError.message
  • ImageDownloadOutofSpaceError
  • ImageDownloadTimeoutError
    • ImageDownloadTimeoutError.message
    • ImageDownloadTimeoutError.status_code
  • ImageWriteError
    • ImageWriteError.message
  • IncompatibleHardwareMethodError
    • IncompatibleHardwareMethodError.message
  • IncompatibleNumaFormatError
    • IncompatibleNumaFormatError.message
  • InspectionError
  • InvalidCommandError
    • InvalidCommandError.message
  • InvalidCommandParamsError
    • InvalidCommandParamsError.message
  • InvalidContentError
    • InvalidContentError.message
    • InvalidContentError.status_code
  • InvalidImage
    • InvalidImage.message
  • InvalidMetricConfig
    • InvalidMetricConfig.message
  • IronicAPIError
    • IronicAPIError.message
  • LookupAgentIPError
    • LookupAgentIPError.message
  • LookupNodeError
    • LookupNodeError.message
  • MetricsNotSupported
    • MetricsNotSupported.message
  • NotFound
    • NotFound.details
    • NotFound.message
    • NotFound.status_code
  • ProtectedDeviceError
    • ProtectedDeviceError.message
  • RESTError
    • RESTError.details
    • RESTError.message
    • RESTError.serializable_fields
    • RESTError.status_code
  • RequestedObjectNotFoundError
  • ServiceLookupFailure
  • ServicingError
    • ServicingError.message
  • SoftwareRAIDError
    • SoftwareRAIDError.message
  • SystemRebootError
    • SystemRebootError.message
  • UnknownNodeError
    • UnknownNodeError.message
  • VersionMismatch
    • VersionMismatch.message
  • VirtualMediaBootError
    • VirtualMediaBootError.message
• ironic_python_agent.hardware module
  • BlockDevice
    • BlockDevice.serializable_fields
  • BootInfo
    • BootInfo.serializable_fields
  • CPU
    • CPU.serializable_fields
  • CPUCore
    • CPUCore.serializable_fields
  • GenericHardwareManager
    • GenericHardwareManager.HARDWARE_MANAGER_NAME
    • GenericHardwareManager.HARDWARE_MANAGER_VERSION
    • GenericHardwareManager.any_ipmi_device_exists()
    • GenericHardwareManager.apply_configuration()
    • GenericHardwareManager.burnin_cpu()
    • GenericHardwareManager.burnin_disk()
    • GenericHardwareManager.burnin_gpu()
    • GenericHardwareManager.burnin_memory()
    • GenericHardwareManager.burnin_network()
    • GenericHardwareManager.clean_uefi_nvram()
    • GenericHardwareManager.collect_lldp_data()
    • GenericHardwareManager.collect_system_logs()
    • GenericHardwareManager.create_configuration()
    • GenericHardwareManager.create_cpu_info_dict()
    • GenericHardwareManager.delete_configuration()
    • GenericHardwareManager.erase_block_device()
    • GenericHardwareManager.erase_devices_express()
    • GenericHardwareManager.erase_devices_metadata()
    • GenericHardwareManager.erase_pstore()
    • GenericHardwareManager.evaluate_hardware_support()
    • GenericHardwareManager.execute_bootc_install()
    • GenericHardwareManager.filter_device()
    • GenericHardwareManager.full_sync()
    • GenericHardwareManager.generate_tls_certificate()
    • GenericHardwareManager.get_bios_given_nic_name()
    • GenericHardwareManager.get_bmc_address()
    • GenericHardwareManager.get_bmc_mac()
    • GenericHardwareManager.get_bmc_v6address()
    • GenericHardwareManager.get_boot_info()
    • GenericHardwareManager.get_clean_steps()
    • GenericHardwareManager.get_cpu_cores()
    • GenericHardwareManager.get_cpus()
    • GenericHardwareManager.get_deploy_steps()
    • GenericHardwareManager.get_interface_info()
    • GenericHardwareManager.get_ipv4_addr()
    • GenericHardwareManager.get_ipv6_addr()
    • GenericHardwareManager.get_memory()
    • GenericHardwareManager.get_os_install_device()
    • GenericHardwareManager.get_service_steps()
    • GenericHardwareManager.get_skip_list_from_node_for_disks()
    • GenericHardwareManager.get_skip_list_from_node_for_raids()
    • GenericHardwareManager.get_system_vendor_info()
    • GenericHardwareManager.get_usb_devices()
    • GenericHardwareManager.initialize()
    • GenericHardwareManager.inject_files()
    • GenericHardwareManager.list_block_devices()
    • GenericHardwareManager.list_block_devices_check_skip_list()
    • GenericHardwareManager.list_hardware_info()
    • GenericHardwareManager.list_network_interfaces()
    • GenericHardwareManager.read_cpu_info()
    • GenericHardwareManager.validate_configuration()
    • GenericHardwareManager.write_image()
  • HardwareManager
    • HardwareManager.collect_lldp_data()
    • HardwareManager.collect_system_logs()
    • HardwareManager.erase_block_device()
    • HardwareManager.erase_devices()
    • HardwareManager.evaluate_hardware_support()
    • HardwareManager.filter_device()
    • HardwareManager.full_sync()
    • HardwareManager.generate_tls_certificate()
    • HardwareManager.get_bmc_address()
    • HardwareManager.get_bmc_mac()
    • HardwareManager.get_bmc_v6address()
    • HardwareManager.get_boot_info()
    • HardwareManager.get_clean_steps()
    • HardwareManager.get_cpus()
    • HardwareManager.get_deploy_steps()
    • HardwareManager.get_interface_info()
    • HardwareManager.get_memory()
    • HardwareManager.get_os_install_device()
    • HardwareManager.get_service_steps()
    • HardwareManager.get_skip_list_from_node_for_disks()
    • HardwareManager.get_skip_list_from_node_for_raids()
    • HardwareManager.get_usb_devices()
    • HardwareManager.get_version()
    • HardwareManager.initialize()
    • HardwareManager.list_block_devices()
    • HardwareManager.list_block_devices_check_skip_list()
    • HardwareManager.list_hardware_info()
    • HardwareManager.list_network_interfaces()
    • HardwareManager.wait_for_disks()
  • HardwareSupport
    • HardwareSupport.GENERIC
    • HardwareSupport.MAINLINE
    • HardwareSupport.NONE
    • HardwareSupport.SERVICE_PROVIDER
  • HardwareType
    • HardwareType.MAC_ADDRESS
  • Memory
    • Memory.serializable_fields
  • NetworkInterface
    • NetworkInterface.serializable_fields
  • SystemFirmware
    • SystemFirmware.serializable_fields
  • SystemVendorInfo
    • SystemVendorInfo.serializable_fields
  • USBInfo
    • USBInfo.serializable_fields
  • cache_node()
  • check_versions()
  • deduplicate_steps()
  • dispatch_to_all_managers()
  • dispatch_to_managers()
  • filter_devices()
  • get_cached_node()
  • get_component_devices()
  • get_current_versions()
  • get_holder_disks()
  • get_managers()
  • get_managers_detail()
  • get_multipath_status()
  • is_md_device()
  • list_all_block_devices()
  • list_hardware_info()
  • md_get_raid_devices()
  • md_restart()
  • safety_check_block_device()
  • save_api_client()
  • update_cached_node()
• ironic_python_agent.inject_files module
  • find_partition_with_path()
  • inject_files()
• ironic_python_agent.inspect module
  • IronicInspection
    • IronicInspection.backoff_factor
    • IronicInspection.max_delay
    • IronicInspection.max_jitter_multiplier
    • IronicInspection.min_jitter_multiplier
    • IronicInspection.run()
• ironic_python_agent.inspector module
  • call_inspector()
  • collect_default()
  • collect_extra_hardware()
  • collect_lldp()
  • collect_logs()
  • collect_pci_devices_info()
  • collect_usb_devices()
  • extension_manager()
  • inspect()
  • wait_for_dhcp()
• ironic_python_agent.ironic_api_client module
  • APIClient
    • APIClient.agent_token
    • APIClient.api_version
    • APIClient.heartbeat()
    • APIClient.heartbeat_api
    • APIClient.lookup_api
    • APIClient.lookup_lock_pause
    • APIClient.lookup_node()
    • APIClient.supports_auto_tls()
• ironic_python_agent.mdns module
  • Zeroconf
    • Zeroconf.close()
    • Zeroconf.get_endpoint()
  • get_endpoint()
  • list_opts()
• ironic_python_agent.netutils module
  • RawPromiscuousSockets
  • bring_up_vlan_interfaces()
  • ethtoolPermAddr
    • ethtoolPermAddr.cmd
    • ethtoolPermAddr.data
    • ethtoolPermAddr.size
  • get_default_ip_addr()
  • get_hostname()
  • get_interface_driver()
  • get_interface_pci_address()
  • get_ipv4_addr()
  • get_ipv6_addr()
  • get_lldp_info()
  • get_mac_addr()
  • get_wildcard_address()
  • ifreq
    • ifreq.ifr_data
    • ifreq.ifr_data_ethtool_perm_addr
    • ifreq.ifr_flags
    • ifreq.ifr_ifrn
  • ifreq_data
    • ifreq_data.ifr_data_ethtool_perm_addr
    • ifreq_data.ifr_flags
  • interface_has_carrier()
  • is_bond()
  • is_network_device()
  • is_vlan()
  • list_interfaces()
  • wrap_ipv6()
• ironic_python_agent.numa_inspector module
  • collect_numa_topology_info()
  • get_nodes_cores_info()
  • get_nodes_memory_info()
  • get_nodes_nics_info()
  • get_numa_node_id()
• ironic_python_agent.partition_utils module
  • create_config_drive_partition()
  • get_configdrive()
  • get_labelled_partition()
  • get_partition()
  • work_on_disk()
• ironic_python_agent.qemu_img module
  • convert_image()
  • image_info()
• ironic_python_agent.raid_utils module
  • calc_raid_partition_sectors()
  • calculate_raid_start()
  • create_raid_device()
  • create_raid_partition_tables()
  • find_esp_raid()
  • get_block_devices_for_raid()
  • get_next_free_raid_device()
  • get_volume_name_of_raid_device()
  • prepare_boot_partitions_for_softraid()
• ironic_python_agent.tls_utils module
  • TlsCertificate
    • TlsCertificate.path
    • TlsCertificate.private_key_path
    • TlsCertificate.text
  • generate_tls_certificate()
• ironic_python_agent.utils module
  • AccumulatedFailures
    • AccumulatedFailures.add()
    • AccumulatedFailures.get_error()
    • AccumulatedFailures.raise_if_needed()
  • StreamingClient
  • collect_system_logs()
  • copy_config_from_vmedia()
  • create_partition_table()
  • determine_time_method()
  • execute()
  • extract_device()
  • find_in_lshw()
  • get_agent_params()
  • get_command_output()
  • get_journalctl_output()
  • get_node_boot_mode()
  • get_partition_table_type_from_specs()
  • get_route_source()
  • get_ssl_client_options()
  • guess_root_disk()
  • gzip_and_b64encode()
  • is_char_device()
  • is_journalctl_present()
  • log_early_log_to_logger()
  • mkfs()
  • mounted()
  • parse_capabilities()
  • parse_device_tags()
  • remove_large_keys()
  • rescan_device()
  • split_device_and_partition_number()
  • sync_clock()
  • try_collect_command_output()
  • try_execute()
  • unlink_without_raise()
• ironic_python_agent.version module

Module contents