ironic_python_agent.errors module

exception ironic_python_agent.errors.AgentIsBusy(command_name)

Bases: CommandExecutionError

message = 'Agent is busy'

status_code = 409

exception ironic_python_agent.errors.BlockDeviceEraseError(details)

Bases: RESTError

Error raised when an error occurs erasing a block device.

message = 'Error erasing block device'

exception ironic_python_agent.errors.BlockDeviceError(details)

Bases: RESTError

Error raised when a block devices causes an unknown error.

message = 'Block device caused unknown error'

exception ironic_python_agent.errors.CleaningError(details=None)

Bases: RESTError

Error raised when a cleaning step fails.

message = 'Clean step failed'

exception ironic_python_agent.errors.ClockSyncError(details=None, *args, **kwargs)

Bases: RESTError

Error raised when attempting to sync the system clock.

message = 'Error syncing system clock'

exception ironic_python_agent.errors.CommandExecutionError(details)

Bases: RESTError

Error raised when a command fails to execute.

message = 'Command execution failed'

exception ironic_python_agent.errors.DeploymentError(details=None)

Bases: RESTError

Error raised when a deploy step fails.

message = 'Deploy step failed'

exception ironic_python_agent.errors.DeviceNotFound(details)

Bases: NotFound

Error raised when the device to deploy the image onto is not found.

message = 'Error finding the disk or partition device to deploy the image onto'

exception ironic_python_agent.errors.ExtensionError(details=None, *args, **kwargs)

Bases: RESTError

exception ironic_python_agent.errors.FileSystemNotSupported(fs)

Bases: RESTError

Error raised when a file system is not supported.

exception ironic_python_agent.errors.HardwareManagerConfigurationError(details=None)

Bases: RESTError

Error raised when a hardware manager has invalid configuration.

message = 'Hardware manager configuration error'

exception ironic_python_agent.errors.HardwareManagerMethodNotFound(method)

Bases: RESTError

Error raised when all HardwareManagers fail to handle a method.

message = 'No HardwareManager found to handle method'

exception ironic_python_agent.errors.HardwareManagerNotFound(details=None)

Bases: RESTError

Error raised when no valid HardwareManager can be found.

message = 'No valid HardwareManager found'

exception ironic_python_agent.errors.HeartbeatConflictError(details)

Bases: IronicAPIError

ConflictError raised when a heartbeat to the agent API fails.

message = 'ConflictError heartbeating to agent API'

exception ironic_python_agent.errors.HeartbeatConnectionError(details)

Bases: IronicAPIError

Transitory connection failure occurred attempting to contact the API.

message = 'Error attempting to heartbeat - Possible transitory network failure or blocking port may be present.'

exception ironic_python_agent.errors.HeartbeatError(details)

Bases: IronicAPIError

Error raised when a heartbeat to the agent API fails.

message = 'Error heartbeating to agent API'

exception ironic_python_agent.errors.ImageChecksumError(image_id, image_location, checksum, calculated_checksum)

Bases: RESTError

Error raised when an image fails to verify against its checksum.

details_str = 'Image failed to verify against checksum. location: {}; image ID: {}; image checksum: {}; verification checksum: {}'

message = 'Error verifying image checksum'

exception ironic_python_agent.errors.ImageDownloadError(image_id, msg)

Bases: RESTError

Error raised when an image cannot be downloaded.

message = 'Error downloading image'

exception ironic_python_agent.errors.ImageDownloadOutofSpaceError(image_id, msg)

Bases: ImageDownloadError

Raised when an image download fails due to insufficient storage.

exception ironic_python_agent.errors.ImageDownloadTimeoutError(image_id, msg)

Bases: RESTError

Raised when an image download operation exceeds its allowed time limit.

message = 'Image download timeout'

status_code = 408

exception ironic_python_agent.errors.ImageWriteError(device, exit_code, stdout, stderr)

Bases: RESTError

Error raised when an image cannot be written to a device.

message = 'Error writing image to device'

exception ironic_python_agent.errors.IncompatibleHardwareMethodError(details=None)

Bases: RESTError

Error raised when HardwareManager method incompatible with hardware.

message = 'HardwareManager method is not compatible with hardware'

exception ironic_python_agent.errors.IncompatibleNumaFormatError(details=None, *args, **kwargs)

Bases: RESTError

Error raised when unexpected format data in NUMA node.

message = 'Error in NUMA node data format'

exception ironic_python_agent.errors.InspectionError

Bases: Exception

Failure during inspection.

exception ironic_python_agent.errors.InvalidCommandError(details)

Bases: InvalidContentError

Error which is raised when an unknown command is issued.

message = 'Invalid command'

exception ironic_python_agent.errors.InvalidCommandParamsError(details)

Bases: InvalidContentError

Error which is raised when command parameters are invalid.

message = 'Invalid command parameters'

exception ironic_python_agent.errors.InvalidContentError(details)

Bases: RESTError

Error which occurs when a user supplies invalid content.

Either because that content cannot be parsed according to the advertised Content-Type, or due to a content validation error.

message = 'Invalid request body'

status_code = 400

exception ironic_python_agent.errors.InvalidImage(details=None)

Bases: DeploymentError

Error raised when an image fails validation for any reason.

message = 'The provided image is not valid for use'

exception ironic_python_agent.errors.InvalidMetricConfig(details=None, *args, **kwargs)

Bases: RESTError

Error raised when a metric config is invalid.

message = 'Invalid value for metrics config option.'

exception ironic_python_agent.errors.IronicAPIError(details)

Bases: RESTError

Error raised when a call to the agent API fails.

message = 'Error in call to ironic-api'

exception ironic_python_agent.errors.LookupAgentIPError(details)

Bases: IronicAPIError

Error raised when automatic IP lookup fails.

message = 'Error finding IP for Ironic Agent'

exception ironic_python_agent.errors.LookupNodeError(details)

Bases: IronicAPIError

Error raised when the node lookup to the Ironic API fails.

message = 'Error getting configuration from Ironic'

exception ironic_python_agent.errors.MetricsNotSupported(details=None, *args, **kwargs)

Bases: RESTError

Error raised when a metrics action is not supported.

message = 'Metrics action is not supported. You may need to adjust the [metrics] section in ironic.conf.'

exception ironic_python_agent.errors.NotFound(details=None, *args, **kwargs)

Bases: RESTError

Error which occurs if a non-existent API endpoint is called.

details = 'The requested URL was not found.'

message = 'Not found'

status_code = 404

exception ironic_python_agent.errors.ProtectedDeviceError(device, what)

Bases: CleaningError

Error raised when a cleaning is halted due to a protected device.

message = 'Protected device located, cleaning aborted.'

exception ironic_python_agent.errors.RESTError(details=None, *args, **kwargs)

Bases: Exception, Serializable

Base class for errors generated in ironic-python-client.

details = 'An unexpected error occurred. Please try back later.'

message = 'An error occurred'

serializable_fields = ('type', 'code', 'message', 'details')

status_code = 500

exception ironic_python_agent.errors.RequestedObjectNotFoundError(type_descr, obj_id)

Bases: NotFound

exception ironic_python_agent.errors.ServiceLookupFailure(service='unknown')

Bases: RESTError

Error raised when an mdns service lookup fails.

exception ironic_python_agent.errors.ServicingError(details=None)

Bases: RESTError

Error raised when a service step fails.

message = 'Service step failed'

exception ironic_python_agent.errors.SoftwareRAIDError(details)

Bases: RESTError

Error raised when a Software RAID causes an error.

message = 'Software RAID caused unknown error'

exception ironic_python_agent.errors.SystemRebootError(exit_code, stdout, stderr)

Bases: RESTError

Error raised when a system cannot reboot.

message = 'Error rebooting system'

exception ironic_python_agent.errors.UnknownNodeError(details=None)

Bases: RESTError

Error raised when the agent is not associated with an Ironic node.

message = 'Agent is not associated with an Ironic node'

exception ironic_python_agent.errors.VersionMismatch(agent_version, node_version)

Bases: RESTError

Error raised when Ironic and the Agent have different versions.

If the agent version has changed since get_clean_steps or get_deploy_steps was called by the Ironic conductor, it indicates the agent has been updated (either on purpose, or a new agent was deployed and the node was rebooted). Since we cannot know if the upgraded IPA will work with cleaning/deploy as it stands (steps could have different priorities, either in IPA or in other Ironic interfaces), we should restart the process from the start.

message = 'Hardware managers version mismatch, reload agent with correct version'

exception ironic_python_agent.errors.VirtualMediaBootError(details)

Bases: RESTError

Error raised when virtual media device cannot be found for config.

message = 'Configuring agent from virtual media failed'