Source code for ironic.common.exception

# Copyright 2010 United States Government as represented by the
# Administrator of the National Aeronautics and Space Administration.
# All Rights Reserved.
#    Licensed under the Apache License, Version 2.0 (the "License"); you may
#    not use this file except in compliance with the License. You may obtain
#    a copy of the License at
#    Unless required by applicable law or agreed to in writing, software
#    distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
#    WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
#    License for the specific language governing permissions and limitations
#    under the License.

"""Ironic specific exceptions list."""

from http import client as http_client

from ironic_lib.exception import IronicException
from oslo_log import log as logging
import wsme

from ironic.common.i18n import _

LOG = logging.getLogger(__name__)

[docs]class NotAuthorized(IronicException): _msg_fmt = _("Not authorized.") code = http_client.FORBIDDEN
[docs]class OperationNotPermitted(NotAuthorized): _msg_fmt = _("Operation not permitted.")
[docs]class Invalid(IronicException): _msg_fmt = _("Unacceptable parameters.") code = http_client.BAD_REQUEST
[docs]class Conflict(IronicException): _msg_fmt = _('Conflict.') code = http_client.CONFLICT
[docs]class TemporaryFailure(IronicException): _msg_fmt = _("Resource temporarily unavailable, please retry.") code = http_client.SERVICE_UNAVAILABLE
[docs]class NotAcceptable(IronicException): # TODO(tenbrae): We need to set response headers in the API # for this exception _msg_fmt = _("Request not acceptable.") code = http_client.NOT_ACCEPTABLE
[docs]class InvalidState(Conflict): _msg_fmt = _("Invalid resource state.")
[docs]class NodeAlreadyExists(Conflict): _msg_fmt = _("A node with UUID %(uuid)s already exists.")
[docs]class MACAlreadyExists(Conflict): _msg_fmt = _("A port with MAC address %(mac)s already exists.")
[docs]class ChassisAlreadyExists(Conflict): _msg_fmt = _("A chassis with UUID %(uuid)s already exists.")
[docs]class PortAlreadyExists(Conflict): _msg_fmt = _("A port with UUID %(uuid)s already exists.")
[docs]class PortgroupAlreadyExists(Conflict): _msg_fmt = _("A portgroup with UUID %(uuid)s already exists.")
[docs]class PortgroupDuplicateName(Conflict): _msg_fmt = _("A portgroup with name %(name)s already exists.")
[docs]class PortgroupMACAlreadyExists(Conflict): _msg_fmt = _("A portgroup with MAC address %(mac)s already exists.")
[docs]class InstanceAssociated(Conflict): _msg_fmt = _("Instance %(instance_uuid)s is already associated with a " "node, it cannot be associated with this other node %(node)s")
[docs]class DuplicateName(Conflict): _msg_fmt = _("A node with name %(name)s already exists.")
[docs]class VolumeConnectorAlreadyExists(Conflict): _msg_fmt = _("A volume connector with UUID %(uuid)s already exists.")
[docs]class VolumeConnectorTypeAndIdAlreadyExists(Conflict): _msg_fmt = _("A volume connector with type %(type)s and connector ID " "%(connector_id)s already exists.")
[docs]class VolumeTargetAlreadyExists(Conflict): _msg_fmt = _("A volume target with UUID %(uuid)s already exists.")
[docs]class VolumeTargetBootIndexAlreadyExists(Conflict): _msg_fmt = _("A volume target with boot index '%(boot_index)s' " "for the same node already exists.")
[docs]class VifAlreadyAttached(Conflict): _msg_fmt = _("Unable to attach VIF because VIF %(vif)s is already " "attached to Ironic %(object_type)s %(object_uuid)s")
[docs]class NoFreePhysicalPorts(Invalid): _msg_fmt = _("Unable to attach VIF %(vif)s, not " "enough free physical ports.")
[docs]class VifNotAttached(Invalid): _msg_fmt = _("Unable to detach VIF %(vif)s from node %(node)s " "because it is not attached to it.")
[docs]class InvalidUUID(Invalid): _msg_fmt = _("Expected a UUID but received %(uuid)s.")
[docs]class InvalidUuidOrName(Invalid): _msg_fmt = _("Expected a logical name or UUID but received %(name)s.")
[docs]class InvalidName(Invalid): _msg_fmt = _("Expected a logical name but received %(name)s.")
[docs]class InvalidConductorGroup(Invalid): _msg_fmt = _("Expected a conductor group but received %(group)s.")
[docs]class InvalidIdentity(Invalid): _msg_fmt = _("Expected a UUID or int but received %(identity)s.")
[docs]class InvalidMAC(Invalid): _msg_fmt = _("Expected a MAC address but received %(mac)s.")
[docs]class InvalidSwitchID(Invalid): _msg_fmt = _("Expected a MAC address or OpenFlow datapath ID but " "received %(switch_id)s.")
[docs]class InvalidDatapathID(Invalid): _msg_fmt = _("Expected an OpenFlow datapath ID but received " "%(datapath_id)s.")
[docs]class InvalidStateRequested(Invalid): _msg_fmt = _('The requested action "%(action)s" can not be performed ' 'on node "%(node)s" while it is in state "%(state)s".')
[docs]class PatchError(Invalid): _msg_fmt = _("Couldn't apply patch '%(patch)s'. Reason: %(reason)s")
[docs]class InstanceDeployFailure(IronicException): _msg_fmt = _("Failed to deploy instance: %(reason)s")
[docs]class ImageUnacceptable(IronicException): _msg_fmt = _("Image %(image_id)s is unacceptable: %(reason)s")
[docs]class ImageConvertFailed(IronicException): _msg_fmt = _("Image %(image_id)s is unacceptable: %(reason)s")
# Cannot be templated as the error syntax varies. # msg needs to be constructed when raised.
[docs]class InvalidParameterValue(Invalid): _msg_fmt = "%(err)s"
[docs]class MissingParameterValue(InvalidParameterValue): _msg_fmt = "%(err)s"
[docs]class Duplicate(IronicException): _msg_fmt = _("Resource already exists.")
[docs]class NotFound(IronicException): _msg_fmt = _("Resource could not be found.") code = http_client.NOT_FOUND
[docs]class DHCPLoadError(IronicException): _msg_fmt = _("Failed to load DHCP provider %(dhcp_provider_name)s, " "reason: %(reason)s")
# TODO(dtantsur): word "driver" is overused in class names here, and generally # means stevedore driver, not ironic driver. Rename them in the future.
[docs]class DriverNotFound(NotFound): _msg_fmt = _("Could not find the following driver(s) or hardware type(s): " "%(driver_name)s.")
[docs]class DriverNotFoundInEntrypoint(DriverNotFound): _msg_fmt = _("Could not find the following items in the " "'%(entrypoint)s' entrypoint: %(names)s.")
[docs]class InterfaceNotFoundInEntrypoint(InvalidParameterValue): _msg_fmt = _("Could not find the following interface in the " "'%(entrypoint)s' entrypoint: %(iface)s. Valid interfaces " "are %(valid)s.")
[docs]class IncompatibleInterface(InvalidParameterValue): _msg_fmt = _("%(interface_type)s interface implementation " "'%(interface_impl)s' is not supported by hardware type " "%(hardware_type)s.")
[docs]class NoValidDefaultForInterface(InvalidParameterValue): # NOTE(rloo): in the line below, there is no blank space after 'For' # because node_info could be an empty string. If node_info # is not empty, it should start with a space. _msg_fmt = _("For%(node_info)s hardware type '%(driver)s', no default " "value found for %(interface_type)s interface.")
[docs]class ImageNotFound(NotFound): _msg_fmt = _("Image %(image_id)s could not be found.")
[docs]class NoValidHost(NotFound): _msg_fmt = _("No valid host was found. Reason: %(reason)s")
[docs]class InstanceNotFound(NotFound): _msg_fmt = _("Instance %(instance)s could not be found.")
[docs]class InputFileError(IronicException): _msg_fmt = _("Error with file %(file_name)s. Reason: %(reason)s")
[docs]class NodeNotFound(NotFound): _msg_fmt = _("Node %(node)s could not be found.")
[docs]class PortgroupNotFound(NotFound): _msg_fmt = _("Portgroup %(portgroup)s could not be found.")
[docs]class PortgroupNotEmpty(Invalid): _msg_fmt = _("Cannot complete the requested action because portgroup " "%(portgroup)s contains ports.")
[docs]class NodeAssociated(InvalidState): _msg_fmt = _("Node %(node)s is associated with instance %(instance)s.")
[docs]class PortNotFound(NotFound): _msg_fmt = _("Port %(port)s could not be found.")
[docs]class FailedToUpdateDHCPOptOnPort(IronicException): _msg_fmt = _("Update DHCP options on port: %(port_id)s failed.")
[docs]class FailedToCleanDHCPOpts(IronicException): _msg_fmt = _("Clean up DHCP options on node: %(node)s failed.")
[docs]class FailedToGetIPAddressOnPort(IronicException): _msg_fmt = _("Retrieve IP address on port: %(port_id)s failed.")
[docs]class InvalidIPv4Address(IronicException): _msg_fmt = _("Invalid IPv4 address %(ip_address)s.")
[docs]class FailedToUpdateMacOnPort(IronicException): _msg_fmt = _("Update MAC address on port: %(port_id)s failed.")
[docs]class ChassisNotFound(NotFound): _msg_fmt = _("Chassis %(chassis)s could not be found.")
[docs]class VolumeConnectorNotFound(NotFound): _msg_fmt = _("Volume connector %(connector)s could not be found.")
[docs]class VolumeTargetNotFound(NotFound): _msg_fmt = _("Volume target %(target)s could not be found.")
[docs]class NoDriversLoaded(IronicException): _msg_fmt = _("Conductor %(conductor)s cannot be started " "because no hardware types were loaded.")
[docs]class ConductorNotFound(NotFound): _msg_fmt = _("Conductor %(conductor)s could not be found.")
[docs]class ConductorAlreadyRegistered(IronicException): _msg_fmt = _("Conductor %(conductor)s already registered.")
[docs]class ConductorHardwareInterfacesAlreadyRegistered(IronicException): _msg_fmt = _("At least one of these (hardware type %(hardware_type)s, " "interface type %(interface_type)s, interfaces " "%(interfaces)s) combinations are already registered for " "this conductor.")
[docs]class PowerStateFailure(InvalidState): _msg_fmt = _("Failed to set node power state to %(pstate)s.")
[docs]class ExclusiveLockRequired(NotAuthorized): _msg_fmt = _("An exclusive lock is required, " "but the current context has a shared lock.")
[docs]class NodeMaintenanceFailure(Invalid): _msg_fmt = _("Failed to toggle maintenance-mode flag " "for node %(node)s: %(reason)s")
[docs]class NodeConsoleNotEnabled(Invalid): _msg_fmt = _("Console access is not enabled on node %(node)s")
[docs]class NodeInMaintenance(Invalid): _msg_fmt = _("The %(op)s operation can't be performed on node " "%(node)s because it's in maintenance mode.")
[docs]class ChassisNotEmpty(Invalid): _msg_fmt = _("Cannot complete the requested action because chassis " "%(chassis)s contains nodes.")
[docs]class IPMIFailure(IronicException): _msg_fmt = _("IPMI call failed: %(cmd)s.")
[docs]class UnsupportedDriverExtension(Invalid): _msg_fmt = _('Driver %(driver)s does not support %(extension)s ' '(disabled or not implemented).')
[docs]class GlanceConnectionFailed(IronicException): _msg_fmt = _("Connection to glance endpoint %(endpoint)s failed: " "%(reason)s")
[docs]class ImageNotAuthorized(NotAuthorized): _msg_fmt = _("Not authorized for image %(image_id)s.")
[docs]class InvalidImageRef(Invalid): _msg_fmt = _("Invalid image href %(image_href)s.")
[docs]class ImageRefValidationFailed(IronicException): _msg_fmt = _("Validation of image href %(image_href)s failed, " "reason: %(reason)s")
[docs]class ImageDownloadFailed(IronicException): _msg_fmt = _("Failed to download image %(image_href)s, reason: %(reason)s")
[docs]class KeystoneUnauthorized(IronicException): _msg_fmt = _("Not authorized in Keystone.")
[docs]class KeystoneFailure(IronicException): pass
[docs]class CatalogNotFound(IronicException): _msg_fmt = _("Service type %(service_type)s with endpoint type " "%(endpoint_type)s not found in keystone service catalog.")
[docs]class ServiceUnavailable(IronicException): _msg_fmt = _("Connection failed")
[docs]class Forbidden(IronicException): _msg_fmt = _("Requested OpenStack Images API is forbidden")
[docs]class BadRequest(IronicException): pass
[docs]class InvalidEndpoint(IronicException): _msg_fmt = _("The provided endpoint is invalid")
[docs]class CommunicationError(IronicException): _msg_fmt = _("Unable to communicate with the server.")
[docs]class HTTPForbidden(NotAuthorized): _msg_fmt = _("Access was denied to the following resource: %(resource)s")
[docs]class Unauthorized(IronicException): pass
[docs]class HTTPNotFound(NotFound): pass
[docs]class ConfigNotFound(IronicException): _msg_fmt = _("Could not find config at %(path)s")
[docs]class NodeLocked(Conflict): _msg_fmt = _("Node %(node)s is locked by host %(host)s, please retry " "after the current operation is completed.")
[docs]class NodeNotLocked(Invalid): _msg_fmt = _("Node %(node)s found not to be locked on release")
[docs]class NoFreeConductorWorker(TemporaryFailure): _msg_fmt = _('Requested action cannot be performed due to lack of free ' 'conductor workers.') code = http_client.SERVICE_UNAVAILABLE
[docs]class VendorPassthruException(IronicException): pass
[docs]class ConfigInvalid(IronicException): _msg_fmt = _("Invalid configuration file. %(error_msg)s")
[docs]class DriverLoadError(IronicException): _msg_fmt = _("Driver, hardware type or interface %(driver)s could not be " "loaded. Reason: %(reason)s.")
[docs]class DriverOperationError(IronicException): _msg_fmt = _("Runtime driver %(driver)s failure. Reason: %(reason)s.")
[docs]class ConsoleError(IronicException): pass
[docs]class NoConsolePid(ConsoleError): _msg_fmt = _("Could not find pid in pid file %(pid_path)s")
[docs]class ConsoleSubprocessFailed(ConsoleError): _msg_fmt = _("Console subprocess failed to start. %(error)s")
[docs]class PasswordFileFailedToCreate(IronicException): _msg_fmt = _("Failed to create the password file. %(error)s")
[docs]class IloOperationError(DriverOperationError): _msg_fmt = _("%(operation)s failed, error: %(error)s")
[docs]class IloOperationNotSupported(DriverOperationError): _msg_fmt = _("%(operation)s not supported. error: %(error)s")
[docs]class DracOperationError(DriverOperationError): _msg_fmt = _('DRAC operation failed. Reason: %(error)s')
[docs]class FailedToGetSensorData(IronicException): _msg_fmt = _("Failed to get sensor data for node %(node)s. " "Error: %(error)s")
[docs]class FailedToParseSensorData(IronicException): _msg_fmt = _("Failed to parse sensor data for node %(node)s. " "Error: %(error)s")
[docs]class InsufficientDiskSpace(IronicException): _msg_fmt = _("Disk volume where '%(path)s' is located doesn't have " "enough disk space. Required %(required)d MiB, " "only %(actual)d MiB available space present.")
[docs]class ImageCreationFailed(IronicException): _msg_fmt = _('Creating %(image_type)s image failed: %(error)s')
[docs]class SwiftOperationError(IronicException): _msg_fmt = _("Swift operation '%(operation)s' failed: %(error)s")
[docs]class SwiftObjectNotFoundError(SwiftOperationError): _msg_fmt = _("Swift object %(obj)s from container %(container)s " "not found. Operation '%(operation)s' failed.")
[docs]class SNMPFailure(DriverOperationError): _msg_fmt = _("SNMP operation '%(operation)s' failed: %(error)s")
[docs]class FileSystemNotSupported(IronicException): _msg_fmt = _("Failed to create a file system. " "File system %(fs)s is not supported.")
[docs]class IRMCOperationError(DriverOperationError): _msg_fmt = _('iRMC %(operation)s failed. Reason: %(error)s')
[docs]class IRMCSharedFileSystemNotMounted(DriverOperationError): _msg_fmt = _("iRMC shared file system '%(share)s' is not mounted.")
[docs]class HardwareInspectionFailure(IronicException): _msg_fmt = _("Failed to inspect hardware. Reason: %(error)s")
[docs]class NodeCleaningFailure(IronicException): _msg_fmt = _("Failed to clean node %(node)s: %(reason)s")
[docs]class PathNotFound(IronicException): _msg_fmt = _("Path %(dir)s does not exist.")
[docs]class DirectoryNotWritable(IronicException): _msg_fmt = _("Directory %(dir)s is not writable.")
[docs]class ImageUploadFailed(IronicException): _msg_fmt = _("Failed to upload %(image_name)s image to web server " "%(web_server)s, reason: %(reason)s")
[docs]class NodeTagNotFound(IronicException): _msg_fmt = _("Node %(node_id)s doesn't have a tag '%(tag)s'")
[docs]class NetworkError(IronicException): _msg_fmt = _("Network operation failure.")
[docs]class IncompleteLookup(Invalid): _msg_fmt = _("At least one of 'addresses' and 'node_uuid' parameters " "is required")
[docs]class NotificationSchemaObjectError(IronicException): _msg_fmt = _("Expected object %(obj)s when populating notification payload" " but got object %(source)s")
[docs]class NotificationSchemaKeyError(IronicException): _msg_fmt = _("Object %(obj)s doesn't have the field \"%(field)s\" " "required for populating notification schema key " "\"%(key)s\"")
[docs]class NotificationPayloadError(IronicException): _msg_fmt = _("Payload not populated when trying to send notification " "\"%(class_name)s\"")
[docs]class StorageError(IronicException): _msg_fmt = _("Storage operation failure.")
[docs]class RedfishError(DriverOperationError): _msg_fmt = _("Redfish exception occurred. Error: %(error)s")
[docs]class RedfishConnectionError(RedfishError): _msg_fmt = _("Redfish connection failed for node %(node)s: %(error)s")
[docs]class PortgroupPhysnetInconsistent(IronicException): _msg_fmt = _("Port group %(portgroup)s has member ports with inconsistent " "physical networks (%(physical_networks)s). All ports in a " "port group must have the same physical network.")
[docs]class VifInvalidForAttach(Conflict): _msg_fmt = _("Unable to attach VIF %(vif)s to node %(node)s. Reason: " "%(reason)s")
[docs]class AgentAPIError(IronicException): _msg_fmt = _('Agent API for node %(node)s returned HTTP status code ' '%(status)s with error: %(error)s')
[docs]class NodeTraitNotFound(NotFound): _msg_fmt = _("Node %(node_id)s doesn't have a trait '%(trait)s'")
[docs]class InstanceRescueFailure(IronicException): _msg_fmt = _('Failed to rescue instance %(instance)s for node ' '%(node)s: %(reason)s')
[docs]class InstanceUnrescueFailure(IronicException): _msg_fmt = _('Failed to unrescue instance %(instance)s for node ' '%(node)s: %(reason)s')
[docs]class XClarityError(IronicException): _msg_fmt = _("XClarity exception occurred. Error: %(error)s")
[docs]class BIOSSettingAlreadyExists(Conflict): _msg_fmt = _('A BIOS setting %(name)s for node %(node)s already exists.')
[docs]class BIOSSettingNotFound(NotFound): _msg_fmt = _("Node %(node)s doesn't have a BIOS setting '%(name)s'")
[docs]class BIOSSettingListNotFound(NotFound): _msg_fmt = _("Node %(node)s doesn't have BIOS settings '%(names)s'")
[docs]class DatabaseVersionTooOld(IronicException): _msg_fmt = _("Database version is too old")
[docs]class AgentConnectionFailed(IronicException): _msg_fmt = _("Connection to agent failed: %(reason)s")
[docs]class NodeProtected(HTTPForbidden): _msg_fmt = _("Node %(node)s is protected and cannot be undeployed, " "rebuilt or deleted")
[docs]class AllocationNotFound(NotFound): _msg_fmt = _("Allocation %(allocation)s could not be found.")
[docs]class AllocationDuplicateName(Conflict): _msg_fmt = _("An allocation with name %(name)s already exists.")
[docs]class AllocationAlreadyExists(Conflict): _msg_fmt = _("An allocation with UUID %(uuid)s already exists.")
[docs]class AllocationFailed(IronicException): _msg_fmt = _("Failed to process allocation %(uuid)s: %(error)s.")
[docs]class DeployTemplateDuplicateName(Conflict): _msg_fmt = _("A deploy template with name %(name)s already exists.")
[docs]class DeployTemplateAlreadyExists(Conflict): _msg_fmt = _("A deploy template with UUID %(uuid)s already exists.")
[docs]class DeployTemplateNotFound(NotFound): _msg_fmt = _("Deploy template %(template)s could not be found.")
[docs]class InvalidDeployTemplate(Invalid): _msg_fmt = _("Deploy template invalid: %(err)s.")
[docs]class IBMCError(DriverOperationError): _msg_fmt = _("IBMC exception occurred on node %(node)s. Error: %(error)s")
[docs]class IBMCConnectionError(IBMCError): _msg_fmt = _("IBMC connection failed for node %(node)s: %(error)s")
[docs]class ClientSideError(wsme.exc.ClientSideError): pass
[docs]class NodeIsRetired(Invalid): _msg_fmt = _("The %(op)s operation can't be performed on node " "%(node)s because it is retired.")
[docs]class NoFreeIPMITerminalPorts(TemporaryFailure): _msg_fmt = _("Unable to allocate a free port on host %(host)s for IPMI " "terminal, not enough free ports.")