heat.common.exception module¶

Heat exception subclasses

exception heat.common.exception.ActionInProgress(**kwargs)[source]¶

Bases: heat.common.exception.HeatException

msg_fmt = 'Stack %(stack_name)s already has an action (%(action)s) in progress.'¶

exception heat.common.exception.ActionNotComplete(**kwargs)[source]¶

Bases: heat.common.exception.HeatException

msg_fmt = 'Stack %(stack_name)s has an action (%(action)s) in progress or failed state.'¶

exception heat.common.exception.AuthorizationFailure(failure_reason='')[source]¶

Bases: heat.common.exception.HeatException

msg_fmt = 'Authorization failed.%(failure_reason)s'¶

exception heat.common.exception.ClientNotAvailable(**kwargs)[source]¶

Bases: heat.common.exception.HeatException

msg_fmt = 'The client (%(client_name)s) is not available.'¶

exception heat.common.exception.ConcurrentTransaction(**kwargs)[source]¶

Bases: heat.common.exception.HeatException

msg_fmt = 'Concurrent transaction for %(action)s'¶

exception heat.common.exception.ConflictingMergeStrategyForParam(**kwargs)[source]¶

Bases: heat.common.exception.HeatException

msg_fmt = "Conflicting merge strategy '%(strategy)s' for parameter '%(param)s' in file '%(env_file)s'."¶

exception heat.common.exception.DownloadLimitExceeded(**kwargs)[source]¶

Bases: heat.common.exception.HeatException

msg_fmt = 'Permissible download limit exceeded: %(message)s'¶

exception heat.common.exception.EgressRuleNotAllowed(**kwargs)[source]¶

Bases: heat.common.exception.HeatException

msg_fmt = "Egress rules are only allowed when Neutron is used and the 'VpcId' property is set."¶

exception heat.common.exception.EntityNotFound(entity=None, name=None, **kwargs)[source]¶

Bases: heat.common.exception.HeatException

msg_fmt = 'The %(entity)s (%(name)s) could not be found.'¶

exception heat.common.exception.Error(msg)[source]¶

Bases: heat.common.exception.HeatException

msg_fmt = '%(message)s'¶

exception heat.common.exception.EventSendFailed(**kwargs)[source]¶

Bases: heat.common.exception.HeatException

msg_fmt = 'Failed to send message to stack (%(stack_name)s) on other engine (%(engine_id)s)'¶

exception heat.common.exception.Forbidden(action='this action')[source]¶

Bases: heat.common.exception.HeatException

msg_fmt = 'You are not authorized to use %(action)s.'¶

exception heat.common.exception.HTTPExceptionDisguise(exception)[source]¶

Bases: Exception

Disguises HTTP exceptions.

They can be handled by the webob fault application in the wsgi pipeline.

safe = True¶

exception heat.common.exception.HeatException(**kwargs)[source]¶

Bases: Exception

Base Heat Exception.

To correctly use this class, inherit from it and define a ‘msg_fmt’ property. That msg_fmt will get formatted with the keyword arguments provided to the constructor.

error_code = None¶

message = 'An unknown exception occurred.'¶

safe = True¶

exception heat.common.exception.HeatExceptionWithPath(error=None, path=None, message=None)[source]¶

Bases: heat.common.exception.HeatException

msg_fmt = '%(error)s%(path)s%(message)s'¶

exception heat.common.exception.ImmutableParameterModified(*args, **kwargs)[source]¶

Bases: heat.common.exception.HeatException

msg_fmt = 'The following parameters are immutable and may not be updated: %(keys)s'¶

exception heat.common.exception.IncompatibleObjectVersion(**kwargs)[source]¶

Bases: heat.common.exception.HeatException

msg_fmt = 'Version %(objver)s of %(objname)s is not supported'¶

exception heat.common.exception.InterfaceAttachFailed(**kwargs)[source]¶

Bases: heat.common.exception.HeatException

msg_fmt = 'Failed to attach interface (%(port)s) to server (%(server)s)'¶

exception heat.common.exception.InterfaceDetachFailed(**kwargs)[source]¶

Bases: heat.common.exception.HeatException

msg_fmt = 'Failed to detach interface (%(port)s) from server (%(server)s)'¶

exception heat.common.exception.Invalid(**kwargs)[source]¶

Bases: heat.common.exception.HeatException

msg_fmt = 'Data supplied was not valid: %(reason)s'¶

exception heat.common.exception.InvalidBreakPointHook(**kwargs)[source]¶

Bases: heat.common.exception.HeatException

msg_fmt = '%(message)s'¶

exception heat.common.exception.InvalidContentType(**kwargs)[source]¶

Bases: heat.common.exception.HeatException

msg_fmt = 'Invalid content type %(content_type)s'¶

exception heat.common.exception.InvalidEncryptionKey(**kwargs)[source]¶

Bases: heat.common.exception.HeatException

msg_fmt = 'Can not decrypt data with the auth_encryption_key in heat config.'¶

exception heat.common.exception.InvalidExternalResourceDependency(**kwargs)[source]¶

Bases: heat.common.exception.HeatException

msg_fmt = 'Invalid dependency with external %(resource_type)s resource: %(external_id)s'¶

exception heat.common.exception.InvalidGlobalResource(**kwargs)[source]¶

Bases: heat.common.exception.HeatException

msg_fmt = 'There was an error loading the definition of the global resource type %(type_name)s.'¶

exception heat.common.exception.InvalidMergeStrategyForParam(**kwargs)[source]¶

Bases: heat.common.exception.HeatException

msg_fmt = "Invalid merge strategy '%(strategy)s' for parameter '%(param)s'."¶

exception heat.common.exception.InvalidRestrictedAction(**kwargs)[source]¶

Bases: heat.common.exception.HeatException

msg_fmt = '%(message)s'¶

exception heat.common.exception.InvalidSchemaError(**kwargs)[source]¶

Bases: heat.common.exception.HeatException

msg_fmt = '%(message)s'¶

exception heat.common.exception.InvalidServiceVersion(**kwargs)[source]¶

Bases: heat.common.exception.HeatException

msg_fmt = 'Invalid service %(service)s version %(version)s'¶

exception heat.common.exception.InvalidTemplateAttribute(**kwargs)[source]¶

Bases: heat.common.exception.HeatException

msg_fmt = 'The Referenced Attribute (%(resource)s %(key)s) is incorrect.'¶

exception heat.common.exception.InvalidTemplateReference(**kwargs)[source]¶

Bases: heat.common.exception.HeatException

msg_fmt = 'The specified reference "%(resource)s" (in %(key)s) is incorrect.'¶

exception heat.common.exception.InvalidTemplateSection(**kwargs)[source]¶

Bases: heat.common.exception.HeatException

msg_fmt = 'The template section is invalid: %(section)s'¶

exception heat.common.exception.InvalidTemplateVersion(**kwargs)[source]¶

Bases: heat.common.exception.HeatException

msg_fmt = 'The template version is invalid: %(explanation)s'¶

exception heat.common.exception.InvalidTemplateVersions(**kwargs)[source]¶

Bases: heat.common.exception.HeatException

msg_fmt = 'A template version alias %(version)s was added for a template class that has no official YYYY-MM-DD version.'¶

exception heat.common.exception.InvalidTenant(**kwargs)[source]¶

Bases: heat.common.exception.HeatException

msg_fmt = 'Searching Tenant %(target)s from Tenant %(actual)s forbidden.'¶

exception heat.common.exception.KeystoneServiceNameConflict(**kwargs)[source]¶

Bases: heat.common.exception.HeatException

msg_fmt = 'Keystone has more than one service with same name %(service)s. Please use service id instead of name'¶

exception heat.common.exception.MissingCredentialError(**kwargs)[source]¶

Bases: heat.common.exception.HeatException

msg_fmt = 'Missing required credential: %(required)s'¶

exception heat.common.exception.NotAuthenticated(**kwargs)[source]¶

Bases: heat.common.exception.HeatException

msg_fmt = 'You are not authenticated.'¶

exception heat.common.exception.NotAuthorized(action='this action')[source]¶

Bases: heat.common.exception.Forbidden

msg_fmt = 'You are not authorized to complete this action.'¶

exception heat.common.exception.NotFound(msg_fmt='Not found')[source]¶

Bases: heat.common.exception.HeatException

exception heat.common.exception.NotSupported(**kwargs)[source]¶

Bases: heat.common.exception.HeatException

msg_fmt = '%(feature)s is not supported.'¶

exception heat.common.exception.ObjectActionError(**kwargs)[source]¶

Bases: heat.common.exception.HeatException

msg_fmt = 'Object action %(action)s failed because: %(reason)s'¶

exception heat.common.exception.ObjectFieldInvalid(**kwargs)[source]¶

Bases: heat.common.exception.HeatException

msg_fmt = 'Field %(field)s of %(objname)s is not an instance of Field'¶

exception heat.common.exception.OrphanedObjectError(**kwargs)[source]¶

Bases: heat.common.exception.HeatException

msg_fmt = 'Cannot call %(method)s on orphaned %(objtype)s object'¶

exception heat.common.exception.PhysicalResourceExists(**kwargs)[source]¶

Bases: heat.common.exception.HeatException

msg_fmt = 'The physical resource for (%(name)s) exists.'¶

exception heat.common.exception.PhysicalResourceIDAmbiguity(**kwargs)[source]¶

Bases: heat.common.exception.HeatException

msg_fmt = 'Multiple resources were found with the physical ID (%(phys_id)s).'¶

exception heat.common.exception.PhysicalResourceNameAmbiguity(**kwargs)[source]¶

Bases: heat.common.exception.HeatException

msg_fmt = 'Multiple physical resources were found with name (%(name)s).'¶

exception heat.common.exception.PropertyUnspecifiedError(*args, **kwargs)[source]¶

Bases: heat.common.exception.HeatException

msg_fmt = 'At least one of the following properties must be specified: %(props)s.'¶

exception heat.common.exception.ReadOnlyFieldError(**kwargs)[source]¶

Bases: heat.common.exception.HeatException

msg_fmt = 'Cannot modify readonly field %(field)s'¶

exception heat.common.exception.RequestLimitExceeded(**kwargs)[source]¶

Bases: heat.common.exception.HeatException

msg_fmt = 'Request limit exceeded: %(message)s'¶

exception heat.common.exception.ResourceActionNotSupported(**kwargs)[source]¶

Bases: heat.common.exception.HeatException

msg_fmt = '%(action)s is not supported for resource.'¶

exception heat.common.exception.ResourceActionRestricted(**kwargs)[source]¶

Bases: heat.common.exception.HeatException

msg_fmt = '%(action)s is restricted for resource.'¶

exception heat.common.exception.ResourceFailure(exception_or_error, resource, action=None)[source]¶

Bases: heat.common.exception.HeatExceptionWithPath

exception heat.common.exception.ResourceInError(status_reason='Unknown', **kwargs)[source]¶

Bases: heat.common.exception.HeatException

msg_fmt = 'Went to status %(resource_status)s due to "%(status_reason)s"'¶

exception heat.common.exception.ResourceNotAvailable(**kwargs)[source]¶

Bases: heat.common.exception.HeatException

msg_fmt = 'The Resource (%(resource_name)s) is not available.'¶

exception heat.common.exception.ResourceNotFound(entity=None, name=None, **kwargs)[source]¶

Bases: heat.common.exception.EntityNotFound

msg_fmt = 'The Resource (%(resource_name)s) could not be found in Stack %(stack_name)s.'¶

exception heat.common.exception.ResourcePropertyConflict(*args, **kwargs)[source]¶

Bases: heat.common.exception.HeatException

msg_fmt = 'Cannot define the following properties at the same time: %(props)s.'¶

exception heat.common.exception.ResourcePropertyDependency(**kwargs)[source]¶

Bases: heat.common.exception.HeatException

msg_fmt = '%(prop1)s cannot be specified without %(prop2)s.'¶

exception heat.common.exception.ResourcePropertyValueDependency(**kwargs)[source]¶

Bases: heat.common.exception.HeatException

msg_fmt = '%(prop1)s property should only be specified for %(prop2)s with value %(value)s.'¶

exception heat.common.exception.ResourceTypeUnavailable(**kwargs)[source]¶

Bases: heat.common.exception.HeatException

error_code = '99001'¶

exception heat.common.exception.ResourceUnknownStatus(result='Resource failed', status_reason='Unknown', **kwargs)[source]¶

Bases: heat.common.exception.HeatException

msg_fmt = '%(result)s - Unknown status %(resource_status)s due to "%(status_reason)s"'¶

exception heat.common.exception.SIGHUPInterrupt(**kwargs)[source]¶

Bases: heat.common.exception.HeatException

msg_fmt = 'System SIGHUP signal received.'¶

exception heat.common.exception.SnapshotNotFound(entity=None, name=None, **kwargs)[source]¶

Bases: heat.common.exception.EntityNotFound

msg_fmt = 'The Snapshot (%(snapshot)s) for Stack (%(stack)s) could not be found.'¶

exception heat.common.exception.StackExists(**kwargs)[source]¶

Bases: heat.common.exception.HeatException

msg_fmt = 'The Stack (%(stack_name)s) already exists.'¶

exception heat.common.exception.StackResourceLimitExceeded(**kwargs)[source]¶

Bases: heat.common.exception.HeatException

msg_fmt = 'Maximum resources per stack exceeded.'¶

exception heat.common.exception.StackValidationFailed(error=None, path=None, message=None, resource=None)[source]¶

Bases: heat.common.exception.HeatExceptionWithPath

exception heat.common.exception.StopActionFailed(**kwargs)[source]¶

Bases: heat.common.exception.HeatException

msg_fmt = 'Failed to stop stack (%(stack_name)s) on other engine (%(engine_id)s)'¶

exception heat.common.exception.TemplateOutputError(**kwargs)[source]¶

Bases: heat.common.exception.HeatException

msg_fmt = 'Error in %(resource)s output %(attribute)s: %(message)s'¶

exception heat.common.exception.UnableToAutoAllocateNetwork(**kwargs)[source]¶

Bases: heat.common.exception.HeatException

msg_fmt = 'Unable to automatically allocate a network: %(message)s'¶

exception heat.common.exception.UnknownUserParameter(**kwargs)[source]¶

Bases: heat.common.exception.HeatException

msg_fmt = 'The Parameter (%(key)s) was not defined in template.'¶

exception heat.common.exception.UnsupportedObjectError(**kwargs)[source]¶

Bases: heat.common.exception.HeatException

msg_fmt = 'Unsupported object type %(objtype)s'¶

exception heat.common.exception.UpdateInProgress(resource_name='Unknown')[source]¶

Bases: Exception

exception heat.common.exception.UpdateReplace(resource_name='Unknown')[source]¶

Bases: Exception

Raised when resource update requires replacement.

exception heat.common.exception.UserParameterMissing(**kwargs)[source]¶

Bases: heat.common.exception.HeatException

msg_fmt = 'The Parameter (%(key)s) was not provided.'¶