Common and Misc Libraries¶
Libraries common throughout manila or just ones that haven’t yet been categorized in depth.
The manila.context
Module¶
RequestContext: context for requests that persist through all of manila.
-
class
RequestContext
(user_id=None, project_id=None, is_admin=None, read_deleted='no', project_name=None, remote_address=None, timestamp=None, quota_class=None, service_catalog=None, **kwargs) Bases:
oslo_context.context.RequestContext
Security context and request information.
Represents the user taking a given action within the system.
-
elevated
(read_deleted=None, overwrite=False) Return a version of this context with admin flag set.
-
classmethod
from_dict
(values) Construct a context object from a provided dictionary.
-
property
read_deleted
-
to_dict
() Return a dictionary of context attributes.
-
to_policy_values
() A dictionary of context attributes to enforce policy with.
oslo.policy enforcement requires a dictionary of attributes representing the current logged in user on which it applies policy enforcement. This dictionary defines a standard list of attributes that should be available for enforcement across services.
It is expected that services will often have to override this method with either deprecated values or additional attributes used by that service specific policy.
-
-
get_admin_context
(read_deleted='no')
The manila.exception
Module¶
Manila base exception handling.
Includes decorator for re-raising Manila-type exceptions.
SHOULD include dedicated exception logging.
-
exception
AdminIPNotFound
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.ManilaException
-
message
= 'Admin port IP for service instance not found: %(reason)s'
-
-
exception
AdminRequired
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.NotAuthorized
-
message
= 'User does not have admin privileges.'
-
-
exception
AllocationsNotFoundForShareServer
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.NotFound
-
message
= 'No allocations found for the share server %(share_server_id)s on the subnet.'
-
-
exception
AvailabilityZoneNotFound
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.NotFound
-
message
= 'Availability zone %(id)s could not be found.'
-
-
exception
BadConfigurationException
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.ManilaException
-
message
= 'Bad configuration: %(reason)s.'
-
-
exception
BridgeDoesNotExist
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.ManilaException
-
message
= 'Bridge %(bridge)s does not exist.'
-
-
exception
ConfigNotFound
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.NotFound
-
message
= 'Could not find config at %(path)s.'
-
-
exception
Conflict
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.ManilaException
-
code
= 409
-
message
= '%(err)s'
-
-
exception
ConvertedException
(code=400, title='', explanation='') Bases:
webob.exc.WSGIHTTPException
-
exception
DefaultShareTypeNotConfigured
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.NotFound
-
message
= 'No default share type is configured. Either configure a default share type or explicitly specify a share type.'
-
-
exception
DriverNotInitialized
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.ManilaException
-
message
= "Share driver '%(driver)s' not initialized."
-
-
exception
EMCPowerMaxInvalidMoverID
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.ManilaException
-
message
= 'Invalid mover or vdm %(id)s.'
-
-
exception
EMCPowerMaxLockRequiredException
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.ManilaException
-
message
= 'Unable to acquire lock(s).'
-
-
exception
EMCPowerMaxXMLAPIError
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.Invalid
-
message
= '%(err)s'
-
-
exception
EMCUnityError
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.ShareBackendException
-
message
= '%(err)s'
-
-
exception
EMCVnxInvalidMoverID
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.ManilaException
-
message
= 'Invalid mover or vdm %(id)s.'
-
-
exception
EMCVnxLockRequiredException
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.ManilaException
-
message
= 'Unable to acquire lock(s).'
-
-
exception
EMCVnxXMLAPIError
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.Invalid
-
message
= '%(err)s'
-
-
exception
Error
Bases:
Exception
-
exception
EvaluatorParseException
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.ManilaException
-
message
= 'Error during evaluator parsing: %(reason)s'
-
-
exception
ExportLocationNotFound
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.NotFound
-
message
= 'Export location %(uuid)s could not be found.'
-
-
exception
FileNotFound
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.NotFound
-
message
= 'File %(file_path)s could not be found.'
-
-
exception
Found
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.ManilaException
-
code
= 302
-
message
= 'Resource was found.'
-
safe
= True
-
-
exception
GPFSException
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.ManilaException
-
message
= 'GPFS exception occurred.'
-
-
exception
GPFSGaneshaException
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.ManilaException
-
message
= 'GPFS Ganesha exception occurred.'
-
-
exception
GaneshaCommandFailure
(**kw) Bases:
oslo_concurrency.processutils.ProcessExecutionError
-
exception
GaneshaException
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.ManilaException
-
message
= 'Unknown NFS-Ganesha library exception.'
-
-
exception
GlusterfsException
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.ManilaException
-
message
= 'Unknown Gluster exception.'
-
-
exception
HDFSException
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.ManilaException
-
message
= 'HDFS exception occurred!'
-
-
exception
HNASBackendException
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.ManilaException
-
message
= 'HNAS Backend Exception: %(msg)s'
-
-
exception
HNASConnException
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.ManilaException
-
message
= 'HNAS Connection Exception: %(msg)s'
-
-
exception
HNASDirectoryNotEmpty
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.ManilaException
-
message
= 'HNAS Directory is not empty: %(msg)s'
-
-
exception
HNASItemNotFoundException
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.StorageResourceNotFound
-
message
= 'HNAS Item Not Found Exception: %(msg)s'
-
-
exception
HNASNothingToCloneException
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.ManilaException
-
message
= 'HNAS Nothing To Clone Exception: %(msg)s'
-
-
exception
HNASSSCContextChange
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.ManilaException
-
message
= 'HNAS SSC Context has been changed unexpectedly: %(msg)s'
-
-
exception
HNASSSCIsBusy
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.ManilaException
-
message
= 'HNAS SSC is busy and cannot execute the command: %(msg)s'
-
-
exception
HPE3ParInvalid
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.Invalid
-
message
= '%(err)s'
-
-
exception
HPE3ParInvalidClient
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.Invalid
-
message
= '%(err)s'
-
-
exception
HPE3ParUnexpectedError
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.ManilaException
-
message
= '%(err)s'
-
-
exception
HSPBackendException
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.ShareBackendException
-
message
= 'HSP Backend Exception: %(msg)s'
-
-
exception
HSPItemNotFoundException
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.ShareBackendException
-
message
= 'HSP Item Not Found Exception: %(msg)s'
-
-
exception
HSPTimeoutException
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.ShareBackendException
-
message
= 'HSP Timeout Exception: %(msg)s'
-
-
exception
HostBinaryNotFound
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.NotFound
-
message
= 'Could not find binary %(binary)s on host %(host)s.'
-
-
exception
HostNotFound
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.NotFound
-
message
= 'Host %(host)s could not be found.'
-
-
exception
IPAddressInUse
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.InUse
-
message
= 'IP address %(ip)s is already used.'
-
-
exception
InUse
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.ManilaException
-
message
= 'Resource is in use.'
-
-
exception
InfortrendCLIException
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.ShareBackendException
-
message
= 'Infortrend CLI exception: %(err)s Return Code: %(rc)s, Output: %(out)s'
-
-
exception
InfortrendNASException
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.ShareBackendException
-
message
= 'Infortrend NAS exception: %(err)s'
-
-
exception
InstanceNotFound
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.NotFound
-
message
= 'Instance %(instance_id)s could not be found.'
-
-
exception
Invalid
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.ManilaException
-
code
= 400
-
message
= 'Unacceptable parameters.'
-
-
exception
InvalidAPIVersionString
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.Invalid
-
message
= 'API Version String %(version)s is of invalid format. Must be of format MajorNum.MinorNum.'
-
-
exception
InvalidCapacity
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.Invalid
-
message
= 'Invalid capacity: %(name)s = %(value)s.'
-
-
exception
InvalidContentType
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.Invalid
-
message
= 'Invalid content type %(content_type)s.'
-
-
exception
InvalidDriverMode
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.Invalid
-
message
= 'Invalid driver mode: %(driver_mode)s.'
-
-
exception
InvalidExtraSpec
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.Invalid
-
message
= 'Invalid extra_spec: %(reason)s.'
-
-
exception
InvalidGlobalAPIVersion
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.Invalid
-
message
= 'Version %(req_ver)s is not supported by the API. Minimum is %(min_ver)s and maximum is %(max_ver)s.'
-
-
exception
InvalidHost
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.Invalid
-
message
= 'Invalid host: %(reason)s'
-
-
exception
InvalidInput
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.Invalid
-
message
= 'Invalid input received: %(reason)s.'
-
-
exception
InvalidMetadata
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.Invalid
-
message
= 'Invalid metadata.'
-
-
exception
InvalidMetadataSize
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.Invalid
-
message
= 'Invalid metadata size.'
-
-
exception
InvalidParameterValue
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.Invalid
-
message
= '%(err)s'
-
-
exception
InvalidQuotaValue
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.Invalid
-
message
= 'Change would make usage less than 0 for the following resources: %(unders)s.'
-
-
exception
InvalidRequest
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.Invalid
-
message
= 'The request is invalid.'
-
-
exception
InvalidReservationExpiration
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.Invalid
-
message
= 'Invalid reservation expiration %(expire)s.'
-
-
exception
InvalidResults
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.Invalid
-
message
= 'The results are invalid.'
-
-
exception
InvalidSecurityService
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.Invalid
-
message
= 'Invalid security service: %(reason)s'
-
-
exception
InvalidShare
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.Invalid
-
message
= 'Invalid share: %(reason)s.'
-
-
exception
InvalidShareAccess
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.Invalid
-
message
= 'Invalid access rule: %(reason)s'
-
-
exception
InvalidShareAccessLevel
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.Invalid
-
message
= 'Invalid or unsupported share access level: %(level)s.'
-
-
exception
InvalidShareAccessType
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.Invalid
-
message
= 'Invalid or unsupported share access type: %(type)s.'
-
-
exception
InvalidShareGroup
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.Invalid
-
message
= 'Invalid share group: %(reason)s'
-
-
exception
InvalidShareGroupSnapshot
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.Invalid
-
message
= 'Invalid share group snapshot: %(reason)s'
-
-
exception
InvalidShareGroupType
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.Invalid
-
message
= 'Invalid share group type: %(reason)s.'
-
-
exception
InvalidShareInstance
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.Invalid
-
message
= 'Invalid share instance: %(reason)s.'
-
-
exception
InvalidShareNetwork
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.Invalid
-
message
= 'Invalid share network: %(reason)s'
-
-
exception
InvalidShareServer
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.Invalid
-
message
= 'Invalid share server: %(reason)s'
-
-
exception
InvalidShareSnapshot
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.Invalid
-
message
= 'Invalid share snapshot: %(reason)s.'
-
-
exception
InvalidShareSnapshotInstance
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.Invalid
-
message
= 'Invalid share snapshot instance: %(reason)s.'
-
-
exception
InvalidShareType
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.Invalid
-
message
= 'Invalid share type: %(reason)s.'
-
-
exception
InvalidSnapshotAccess
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.Invalid
-
message
= 'Invalid access rule: %(reason)s'
-
-
exception
InvalidSqliteDB
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.Invalid
-
message
= 'Invalid Sqlite database.'
-
-
exception
InvalidUUID
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.Invalid
-
message
= '%(uuid)s is not a valid uuid.'
-
-
exception
InvalidVolume
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.Invalid
-
message
= 'Invalid volume.'
-
-
exception
LockCreationFailed
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.ManilaException
-
message
= 'Unable to create lock. Coordination backend not started.'
-
-
exception
LockingFailed
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.ManilaException
-
message
= 'Lock acquisition failed.'
-
-
exception
MalformedRequestBody
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.ManilaException
-
message
= 'Malformed message body: %(reason)s.'
-
-
exception
ManageExistingShareTypeMismatch
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.ManilaException
-
message
= 'Manage existing share failed due to share type mismatch: %(reason)s'
-
-
exception
ManageInvalidShare
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.InvalidShare
-
message
= 'Manage existing share failed due to invalid share: %(reason)s'
-
-
exception
ManageInvalidShareSnapshot
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.InvalidShareSnapshot
-
message
= 'Manage existing share snapshot failed due to invalid share snapshot: %(reason)s.'
-
-
exception
ManageShareServerError
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.ManilaException
-
message
= 'Manage existing share server failed due to: %(reason)s'
-
-
exception
ManilaException
(message=None, detail_data={}, **kwargs) Bases:
Exception
Base Manila Exception
To correctly use this class, inherit from it and define a ‘message’ property. That message will get printf’d with the keyword arguments provided to the constructor.
-
code
= 500
-
headers
= {}
-
message
= 'An unknown exception occurred.'
-
safe
= False
-
-
exception
MapRFSException
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.ManilaException
-
message
= 'MapRFS exception occurred: %(msg)s'
-
-
exception
MessageNotFound
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.NotFound
-
message
= 'Message %(message_id)s could not be found.'
-
-
exception
MetadataItemNotFound
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.NotFound
-
message
= 'Metadata item is not found.'
-
-
exception
MigrationError
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.ManilaException
-
message
= 'Migration error: %(reason)s.'
-
-
exception
MigrationNotFound
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.NotFound
-
message
= 'Migration %(migration_id)s could not be found.'
-
-
exception
MigrationNotFoundByStatus
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.MigrationNotFound
-
message
= 'Migration not found for instance %(instance_id)s with status %(status)s.'
-
-
exception
NetAppBusyAggregateForFlexGroupException
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.ManilaException
-
message
= 'Exception due to an aggregate being busy while trying to provision the FlexGroup.'
-
-
exception
NetAppException
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.ManilaException
-
message
= 'Exception due to NetApp failure.'
-
-
exception
NetworkBadConfigurationException
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.NetworkException
-
message
= 'Bad network configuration: %(reason)s.'
-
-
exception
NetworkBindException
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.ManilaException
-
message
= 'Exception due to failed port status in binding.'
-
-
exception
NetworkException
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.ManilaException
-
message
= 'Exception due to network failure.'
-
-
exception
NexentaException
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.ShareBackendException
-
message
= 'Exception due to Nexenta failure. %(reason)s'
-
-
exception
NoValidHost
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.ManilaException
-
message
= 'No valid host was found. %(reason)s.'
-
-
exception
NotAuthorized
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.ManilaException
-
code
= 403
-
message
= 'Not authorized.'
-
-
exception
NotFound
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.ManilaException
-
code
= 404
-
message
= 'Resource could not be found.'
-
safe
= True
-
-
exception
OverQuota
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.ManilaException
-
message
= 'Quota exceeded for resources: %(overs)s.'
-
-
exception
PasteAppNotFound
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.NotFound
-
message
= "Could not load paste app '%(name)s' from %(path)s."
-
-
exception
PolicyNotAuthorized
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.NotAuthorized
-
message
= "Policy doesn't allow %(action)s to be performed."
-
-
exception
PortLimitExceeded
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.QuotaError
-
message
= 'Maximum number of ports exceeded.'
-
-
exception
ProjectQuotaNotFound
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.QuotaNotFound
-
message
= 'Quota for project %(project_id)s could not be found.'
-
-
exception
ProjectShareTypeQuotaNotFound
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.QuotaNotFound
-
message
= 'Quota for share_type %(share_type)s in project %(project_id)s could not be found.'
-
-
exception
ProjectUserQuotaNotFound
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.QuotaNotFound
-
message
= 'Quota for user %(user_id)s in project %(project_id)s could not be found.'
-
-
exception
QBException
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.ManilaException
-
message
= 'Quobyte exception occurred: %(msg)s'
-
-
exception
QBRpcException
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.ManilaException
Quobyte backend specific exception.
-
message
= 'Quobyte JsonRpc call to backend raised an exception: %(result)s, Quobyte error code %(qbcode)s'
-
-
exception
QuotaClassNotFound
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.QuotaNotFound
-
message
= 'Quota class %(class_name)s could not be found.'
-
-
exception
QuotaError
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.ManilaException
-
code
= 413
-
headers
= {'Retry-After': '0'}
-
message
= 'Quota exceeded: code=%(code)s.'
-
safe
= True
-
-
exception
QuotaExists
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.ManilaException
-
message
= 'Quota exists for project %(project_id)s, resource %(resource)s.'
-
-
exception
QuotaNotFound
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.NotFound
-
message
= 'Quota could not be found.'
-
-
exception
QuotaResourceUnknown
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.QuotaNotFound
-
message
= 'Unknown quota resources %(unknown)s.'
-
-
exception
QuotaUsageNotFound
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.QuotaNotFound
-
message
= 'Quota usage for project %(project_id)s could not be found.'
-
-
exception
ReplicationException
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.ManilaException
-
message
= 'Unable to perform a replication action: %(reason)s.'
-
-
exception
ReservationNotFound
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.QuotaNotFound
-
message
= 'Quota reservation %(uuid)s could not be found.'
-
-
exception
SSHException
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.ManilaException
-
message
= 'Exception in SSH protocol negotiation or logic.'
-
-
exception
SSHInjectionThreat
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.ManilaException
-
message
= 'SSH command injection detected: %(command)s'
-
-
exception
SchedulerHostFilterNotFound
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.NotFound
-
message
= 'Scheduler host filter %(filter_name)s could not be found.'
-
-
exception
SchedulerHostWeigherNotFound
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.NotFound
-
message
= 'Scheduler host weigher %(weigher_name)s could not be found.'
-
-
exception
SecurityServiceFailedAuth
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.ManilaException
-
message
= 'Failed to authenticate user against security service.'
-
-
exception
SecurityServiceNotFound
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.NotFound
-
message
= 'Security service %(security_service_id)s could not be found.'
-
-
exception
ServiceIPNotFound
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.ManilaException
-
message
= 'Service IP for instance not found: %(reason)s'
-
-
exception
ServiceInstanceException
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.ManilaException
-
message
= 'Exception in service instance manager occurred.'
-
-
exception
ServiceInstanceUnavailable
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.ServiceInstanceException
-
message
= 'Service instance is not available.'
-
-
exception
ServiceIsDown
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.Invalid
-
message
= 'Service %(service)s is down.'
-
-
exception
ServiceNotFound
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.NotFound
-
message
= 'Service %(service_id)s could not be found.'
-
-
exception
ShareAccessExists
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.ManilaException
-
message
= 'Share access %(access_type)s:%(access)s exists.'
-
-
exception
ShareAccessMetadataNotFound
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.NotFound
-
message
= 'Share access rule metadata does not exist.'
-
-
exception
ShareBackendException
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.ManilaException
-
message
= 'Share backend error: %(msg)s.'
-
-
exception
ShareBusyException
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.Invalid
-
message
= 'Share is busy with an active task: %(reason)s.'
-
-
exception
ShareCopyDataException
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.ManilaException
-
message
= 'Failed to copy data: %(reason)s'
-
-
exception
ShareDataCopyCancelled
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.ManilaException
-
message
= 'Copy of contents from share instance %(src_instance)s to share instance %(dest_instance)s was cancelled.'
-
-
exception
ShareDataCopyFailed
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.ManilaException
-
message
= 'Share Data copy failed: %(reason)s'
-
-
exception
ShareExtendingError
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.ManilaException
-
message
= 'Share %(share_id)s could not be extended due to error in the driver: %(reason)s'
-
-
exception
ShareGroupNotFound
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.NotFound
-
message
= 'Share group %(share_group_id)s could not be found.'
-
-
exception
ShareGroupSnapshotMemberNotFound
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.NotFound
-
message
= 'Share group snapshot member %(member_id)s could not be found.'
-
-
exception
ShareGroupSnapshotNotFound
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.NotFound
-
message
= 'Share group snapshot %(share_group_snapshot_id)s could not be found.'
-
-
exception
ShareGroupSnapshotNotSupported
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.ManilaException
-
message
= 'Share group %(share_group)s does not support snapshots.'
-
-
exception
ShareGroupSnapshotsLimitExceeded
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.QuotaError
-
message
= 'Maximum number of allowed share-group-snapshots is exceeded.'
-
-
exception
ShareGroupTypeAccessExists
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.ManilaException
-
message
= 'Share group type access for %(type_id)s / %(project_id)s combination already exists.'
-
-
exception
ShareGroupTypeAccessNotFound
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.NotFound
-
message
= 'Share group type access not found for %(type_id)s / %(project_id)s combination.'
-
-
exception
ShareGroupTypeCreateFailed
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.ManilaException
-
message
= 'Cannot create share group type with name %(name)s and specs %(group_specs)s.'
-
-
exception
ShareGroupTypeExists
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.ManilaException
-
message
= 'Share group type %(type_id)s already exists.'
-
-
exception
ShareGroupTypeInUse
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.ManilaException
-
message
= 'Share group Type %(type_id)s deletion is not allowed with groups present with the type.'
-
-
exception
ShareGroupTypeNotFound
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.NotFound
-
message
= 'Share group type %(type_id)s could not be found.'
-
-
exception
ShareGroupTypeNotFoundByName
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.ShareTypeNotFound
-
message
= 'Share group type with name %(type_name)s could not be found.'
-
-
exception
ShareGroupTypeSpecsNotFound
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.NotFound
-
message
= 'Share group type %(type_id)s has no group specs with key %(specs_key)s.'
-
-
exception
ShareGroupsLimitExceeded
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.QuotaError
-
message
= 'Maximum number of allowed share-groups is exceeded.'
-
-
exception
ShareInstanceNotFound
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.NotFound
-
message
= 'Share instance %(share_instance_id)s could not be found.'
-
-
exception
ShareLimitExceeded
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.QuotaError
-
message
= 'Maximum number of shares allowed (%(allowed)d) either per project/user or share type quota is exceeded.'
-
-
exception
ShareMigrationError
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.ManilaException
-
message
= 'Error in share migration: %(reason)s'
-
-
exception
ShareMigrationFailed
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.ManilaException
-
message
= 'Share migration failed: %(reason)s'
-
-
exception
ShareMountException
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.ManilaException
-
message
= 'Failed to mount share: %(reason)s'
-
-
exception
ShareNetworkNotFound
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.NotFound
-
message
= 'Share network %(share_network_id)s could not be found.'
-
-
exception
ShareNetworkSecurityServiceAssociationError
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.ManilaException
-
message
= 'Failed to associate share network %(share_network_id)s and security service %(security_service_id)s: %(reason)s.'
-
-
exception
ShareNetworkSecurityServiceDissociationError
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.ManilaException
-
message
= 'Failed to dissociate share network %(share_network_id)s and security service %(security_service_id)s: %(reason)s.'
-
-
exception
ShareNetworkSubnetNotFound
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.NotFound
-
message
= 'Share network subnet %(share_network_subnet_id)s could not be found.'
-
-
exception
ShareNetworkSubnetNotFoundByShareServer
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.NotFound
-
message
= 'Share network subnet could not be found by %(share_server_id)s.'
-
-
exception
ShareNetworksLimitExceeded
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.QuotaError
-
message
= 'Maximum number of share-networks allowed (%(allowed)d) exceeded.'
-
-
exception
ShareNotFound
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.NotFound
-
message
= 'Share %(share_id)s could not be found.'
-
-
exception
ShareReplicaNotFound
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.NotFound
-
message
= 'Share Replica %(replica_id)s could not be found.'
-
-
exception
ShareReplicaSizeExceedsAvailableQuota
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.QuotaError
-
message
= 'Requested share replica exceeds allowed project/user or share type gigabytes quota.'
-
-
exception
ShareReplicasLimitExceeded
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.QuotaError
-
message
= 'Maximum number of allowed share-replicas is exceeded.'
-
-
exception
ShareResourceNotFound
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.StorageResourceNotFound
-
message
= 'Share id %(share_id)s could not be found in storage backend.'
-
-
exception
ShareServerBackendDetailsNotFound
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.NotFound
-
message
= 'Share server backend details does not exist.'
-
-
exception
ShareServerInUse
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.InUse
-
message
= 'Share server %(share_server_id)s is in use.'
-
-
exception
ShareServerMigrationError
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.ManilaException
-
message
= 'Error in share server migration: %(reason)s'
-
-
exception
ShareServerMigrationFailed
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.ManilaException
-
message
= 'Share server migration failed: %(reason)s'
-
-
exception
ShareServerNotCreated
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.ManilaException
-
message
= 'Share server %(share_server_id)s failed on creation.'
-
-
exception
ShareServerNotFound
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.NotFound
-
message
= 'Share server %(share_server_id)s could not be found.'
-
-
exception
ShareServerNotFoundByFilters
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.ShareServerNotFound
-
message
= 'Share server could not be found by filters: %(filters_description)s.'
-
-
exception
ShareServerNotReady
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.ManilaException
-
message
= "Share server %(share_server_id)s failed to reach '%(state)s' within %(time)s seconds."
-
-
exception
ShareShrinkingError
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.ManilaException
-
message
= 'Share %(share_id)s could not be shrunk due to error in the driver: %(reason)s'
-
-
exception
ShareShrinkingPossibleDataLoss
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.ManilaException
-
message
= 'Share %(share_id)s could not be shrunk due to possible data loss'
-
-
exception
ShareSizeExceedsAvailableQuota
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.QuotaError
-
message
= 'Requested share exceeds allowed project/user or share type gigabytes quota.'
-
-
exception
ShareSizeExceedsLimit
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.QuotaError
-
message
= 'Requested share size %(size)d is larger than maximum allowed limit %(limit)d.'
-
-
exception
ShareSnapshotAccessExists
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.InvalidInput
-
message
= 'Share snapshot access %(access_type)s:%(access)s exists.'
-
-
exception
ShareSnapshotInstanceNotFound
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.NotFound
-
message
= 'Snapshot instance %(instance_id)s could not be found.'
-
-
exception
ShareSnapshotIsBusy
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.ManilaException
-
message
= 'Deleting snapshot %(snapshot_name)s that has dependent shares.'
-
-
exception
ShareSnapshotNotFound
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.NotFound
-
message
= 'Snapshot %(snapshot_id)s could not be found.'
-
-
exception
ShareSnapshotNotSupported
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.ManilaException
-
message
= 'Share %(share_name)s does not support snapshots.'
-
-
exception
ShareTypeAccessExists
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.ManilaException
-
message
= 'Share type access for %(share_type_id)s / %(project_id)s combination already exists.'
-
-
exception
ShareTypeAccessNotFound
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.NotFound
-
message
= 'Share type access not found for %(share_type_id)s / %(project_id)s combination.'
-
-
exception
ShareTypeCreateFailed
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.ManilaException
-
message
= 'Cannot create share_type with name %(name)s and specs %(extra_specs)s.'
-
-
exception
ShareTypeDoesNotExist
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.NotFound
-
message
= 'Share Type %(share_type)s does not exist.'
-
-
exception
ShareTypeExists
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.ManilaException
-
message
= 'Share Type %(id)s already exists.'
-
-
exception
ShareTypeExtraSpecsNotFound
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.NotFound
-
message
= 'Share Type %(share_type_id)s has no extra specs with key %(extra_specs_key)s.'
-
-
exception
ShareTypeInUse
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.ManilaException
-
message
= 'Share Type %(share_type_id)s deletion is not allowed while shares or share group types are associated with the type.'
-
-
exception
ShareTypeNotFound
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.NotFound
-
message
= 'Share type %(share_type_id)s could not be found.'
-
-
exception
ShareTypeNotFoundByName
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.ShareTypeNotFound
-
message
= 'Share type with name %(share_type_name)s could not be found.'
-
-
exception
ShareTypeUpdateFailed
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.ManilaException
-
message
= 'Cannot update share_type %(id)s.'
-
-
exception
ShareUmountException
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.ManilaException
-
message
= 'Failed to unmount share: %(reason)s'
-
-
exception
SnapshotLimitExceeded
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.QuotaError
-
message
= 'Maximum number of snapshots allowed (%(allowed)d) either per project/user or share type quota is exceeded.'
-
-
exception
SnapshotResourceNotFound
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.StorageResourceNotFound
-
message
= 'Snapshot %(name)s not found.'
-
-
exception
SnapshotSizeExceedsAvailableQuota
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.QuotaError
-
message
= 'Requested snapshot exceeds allowed project/user or share type gigabytes quota.'
-
-
exception
SnapshotUnavailable
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.StorageResourceException
-
message
= 'Snapshot %(name)s info not available.'
-
-
exception
StorageCommunicationException
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.ShareBackendException
-
message
= 'Could not communicate with storage array.'
-
-
exception
StorageResourceException
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.ManilaException
-
message
= 'Storage resource exception.'
-
-
exception
StorageResourceNotFound
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.StorageResourceException
-
code
= 404
-
message
= 'Storage resource %(name)s not found.'
-
-
exception
TegileAPIException
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.ShareBackendException
-
message
= 'Unexpected response from Tegile IntelliFlash API: %(response)s'
-
-
exception
UnmanageInvalidShare
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.InvalidShare
-
message
= 'Unmanage existing share failed due to invalid share: %(reason)s'
-
-
exception
UnmanageInvalidShareSnapshot
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.InvalidShareSnapshot
-
message
= 'Unmanage existing share snapshot failed due to invalid share snapshot: %(reason)s.'
-
-
exception
VersionNotFoundForAPIMethod
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.Invalid
-
message
= 'API version %(version)s is not supported on this method.'
-
-
exception
VolumeNotFound
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.NotFound
-
message
= 'Volume %(volume_id)s could not be found.'
-
-
exception
VolumeSnapshotNotFound
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.NotFound
-
message
= 'Snapshot %(snapshot_id)s could not be found.'
-
-
exception
VserverNotFound
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.NetAppException
-
message
= 'Vserver %(vserver)s not found.'
-
-
exception
VserverNotReady
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.NetAppException
-
message
= 'Vserver %(vserver)s is not ready yet.'
-
-
exception
VserverNotSpecified
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.NetAppException
-
message
= 'Vserver not specified.'
-
-
exception
WillNotSchedule
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.ManilaException
-
message
= "Host %(host)s is not up or doesn't exist."
-
-
exception
ZFSonLinuxException
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.ManilaException
-
message
= 'ZFSonLinux exception occurred: %(msg)s'
-
-
exception
ZadaraAttachmentsNotFound
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.ShareBackendException
-
message
= 'Failed to retrieve attachments for volume %(name)s'
-
-
exception
ZadaraBadHTTPResponseStatus
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.ShareBackendException
-
message
= 'Bad HTTP response status %(status)s'
-
-
exception
ZadaraExtendShareFailed
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.ShareBackendException
-
message
= 'Failed to extend VPSA backend share. Error: %(error)s'
-
-
exception
ZadaraFailedCmdWithDump
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.ShareBackendException
-
message
= 'Operation failed with status=%(status)s. Full dump: %(data)s'
-
-
exception
ZadaraInvalidProtocol
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.ShareBackendException
-
message
= 'The type of protocol %(protocol_type)s for Zadara manila driver is not supported. Only NFS or CIFS protocol is supported.'
-
-
exception
ZadaraInvalidShareAccessType
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.ShareBackendException
-
message
= 'Only ip access type allowed for the Zadara manila share.'
-
-
exception
ZadaraManilaInvalidAccessKey
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.ShareBackendException
-
message
= 'Invalid VPSA access key'
-
-
exception
ZadaraServerCreateFailure
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.ShareBackendException
-
message
= 'Unable to create server object for initiator %(name)s'
-
-
exception
ZadaraServerNotFound
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.NotFound
-
message
= 'Unable to find server object for initiator %(name)s'
-
-
exception
ZadaraSessionRequestException
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.ShareBackendException
-
message
= '%(msg)s'
-
-
exception
ZadaraShareNotFound
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.ShareBackendException
-
message
= 'Share %(name)s could not be found.'
-
-
exception
ZadaraShareNotValid
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.ShareBackendException
-
message
= 'Share %(name)s is not valid.'
-
-
exception
ZadaraUnknownCmd
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.ShareBackendException
-
message
= 'Unknown or unsupported command %(cmd)s'
-
-
exception
ZadaraVPSANoActiveController
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.ShareBackendException
-
message
= 'Unable to find any active VPSA controller'
-
-
exception
ZadaraVPSASnapshotCreateFailed
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.ShareBackendException
-
message
= 'Failed to create VPSA share %(name)s snapshot. Error: %(error)s'
-
-
exception
ZadaraVPSASnapshotManageFailed
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.ShareBackendException
-
message
= 'Failed to manage VPSA share snapshot with id %(snap_id)s. Error: %(error)s'
-
-
exception
ZadaraVPSAVolumeShareFailed
(message=None, detail_data={}, **kwargs) Bases:
manila.exception.ShareBackendException
-
message
= 'Failed to create VPSA backend share. Error: %(error)s'
-
The manila.test
Module¶
The manila.utils
Module¶
Utilities and helper functions.
-
class
ComparableMixin
Bases:
object
-
DO_NOTHING
Class that literrally does nothing.
We inherit from str in case it’s called with json.dumps.
-
class
DoNothing
Bases:
str
Class that literrally does nothing.
We inherit from str in case it’s called with json.dumps.
-
class
IsAMatcher
(expected_value=None) Bases:
object
-
class
LazyPluggable
(pivot, **backends) Bases:
object
A pluggable backend loaded lazily based on some value.
-
class
SSHPool
(ip, port, conn_timeout, login, password=None, privatekey=None, *args, **kwargs) Bases:
eventlet.pools.Pool
A simple eventlet pool to hold ssh connections.
-
create
() Generate a new pool item. In order for the pool to function, either this method must be overriden in a subclass or the pool must be constructed with the create argument. It accepts no arguments and returns a single instance of whatever thing the pool is supposed to contain.
In general,
create()
is called whenever the pool exceeds its previous high-water mark of concurrently-checked-out-items. In other words, in a new pool with min_size of 0, the very first call toget()
will result in a call tocreate()
. If the first caller callsput()
before some other caller callsget()
, then the first item will be returned, andcreate()
will not be called a second time.
-
get
() Return an item from the pool, when one is available.
This may cause the calling greenthread to block. Check if a connection is active before returning it. For dead connections create and return a new connection.
-
remove
(ssh) Close an ssh client and remove it from free_items.
-
-
check_params_are_boolean
(keys, params, default=False) Validates if keys in params are boolean.
- Parameters
keys – List of keys to check
params – Parameters received from REST API
default – default value when it does not exist
- Returns
a dictionary with keys and respective retrieved value
-
check_params_exist
(keys, params) Validates if keys exist in params.
- Parameters
keys – List of keys to check
params – Parameters received from REST API
-
check_ssh_injection
(cmd_list)
-
cidr_to_netmask
(cidr) Convert cidr to netmask.
-
cidr_to_network
(cidr) Convert cidr to network.
-
cidr_to_prefixlen
(cidr) Convert cidr to prefix length.
-
convert_str
(text) Convert to native string.
Convert bytes and Unicode strings to native strings:
convert to Unicode on Python 3: decode bytes from UTF-8
-
execute
(*cmd, **kwargs) Convenience wrapper around oslo’s execute() function.
-
file_open
(*args, **kwargs) Open file
see built-in open() documentation for more details
- Note: The reason this is kept in a separate module is to easily
be able to provide a stub module that doesn’t alter system state at all (for unit tests)
-
get_bool_from_api_params
(key, params, default=False, strict=True) Parse bool value from request params.
HTTPBadRequest will be directly raised either of the cases below: 1. invalid bool string was found by key(with strict on). 2. key not found while default value is invalid(with strict on).
-
get_bool_param
(param_string, params, default=False)
-
if_notifications_enabled
(function) Calls decorated method only if notifications are enabled.
-
is_all_tenants
(search_opts) Checks to see if the all_tenants flag is in search_opts
- Parameters
search_opts (dict) – The search options for a request
- Returns
boolean indicating if all_tenants are being requested or not
-
is_valid_ip_address
(ip_address, ip_version)
-
isotime
(at=None, subsecond=False) Stringify time in ISO 8601 format.
-
monkey_patch
() Patch decorator.
If the Flags.monkey_patch set as True, this function patches a decorator for all functions in specified modules. You can set decorators for each modules using CONF.monkey_patch_modules. The format is “Module path:Decorator function”. Example: ‘manila.api.ec2.cloud:’ manila.openstack.common.notifier.api.notify_decorator’
Parameters of the decorator is as follows. (See manila.openstack.common.notifier.api.notify_decorator)
name - name of the function function - object of the function
-
notifications_enabled
(conf) Check if oslo notifications are enabled.
-
require_driver_initialized
(func)
-
retry
(retry_param=<class 'Exception'>, interval=1, retries=10, backoff_rate=2, backoff_sleep_max=None, wait_random=False, infinite=False, retry=<class 'tenacity.retry.retry_if_exception_type'>)
-
class
retry_if_exit_code
(codes) Bases:
tenacity.retry.retry_if_exception
Retry on ProcessExecutionError specific exit codes.
-
service_is_up
(service) Check whether a service is up based on last heartbeat.
-
tempdir
(**kwargs)
-
translate_string_size_to_float
(string, multiplier='G') Translates human-readable storage size to float value.
- Supported values for ‘multiplier’ are following:
K - kilo | 1 M - mega | 1024 G - giga | 1024 * 1024 T - tera | 1024 * 1024 * 1024 P = peta | 1024 * 1024 * 1024 * 1024
- returns:
float if correct input data provided
None if incorrect
-
validate_service_host
(context, host)
-
wait_for_access_update
(context, db, share_instance, migration_wait_access_rules_timeout)
-
walk_class_hierarchy
(clazz, encountered=None) Walk class hierarchy, yielding most derived classes first.
-
write_local_file
(filename, contents, as_root=False)
-
write_remote_file
(ssh, filename, contents, as_root=False)