ironicclient.common.apiclient.exceptions module¶

Exception definitions.

exception ironicclient.common.apiclient.exceptions.AmbiguousEndpoints(endpoints=None)[source]¶

Bases: ironicclient.common.apiclient.exceptions.EndpointException

Found more than one matching endpoint in Service Catalog.

exception ironicclient.common.apiclient.exceptions.AuthPluginOptionsMissing(opt_names)[source]¶

Bases: ironicclient.common.apiclient.exceptions.AuthorizationFailure

Auth plugin misses some options.

exception ironicclient.common.apiclient.exceptions.AuthSystemNotFound(auth_system)[source]¶

Bases: ironicclient.common.apiclient.exceptions.AuthorizationFailure

User has specified an AuthSystem that is not installed.

exception ironicclient.common.apiclient.exceptions.AuthorizationFailure[source]¶

Bases: ironicclient.common.apiclient.exceptions.ClientException

Cannot authorize API client.

exception ironicclient.common.apiclient.exceptions.BadGateway(message=None, details=None, response=None, request_id=None, url=None, method=None, http_status=None)[source]¶

Bases: ironicclient.common.apiclient.exceptions.HttpServerError

HTTP 502 - Bad Gateway.

The server was acting as a gateway or proxy and received an invalid response from the upstream server.

http_status = 502¶

message = 'Bad Gateway'¶

exception ironicclient.common.apiclient.exceptions.BadRequest(message=None, details=None, response=None, request_id=None, url=None, method=None, http_status=None)[source]¶

Bases: ironicclient.common.apiclient.exceptions.HTTPClientError

HTTP 400 - Bad Request.

The request cannot be fulfilled due to bad syntax.

http_status = 400¶

message = 'Bad Request'¶

exception ironicclient.common.apiclient.exceptions.ClientException[source]¶

Bases: Exception

The base exception class for all exceptions this library raises.

exception ironicclient.common.apiclient.exceptions.CommandError[source]¶

Bases: ironicclient.common.apiclient.exceptions.ClientException

Error in CLI tool.

exception ironicclient.common.apiclient.exceptions.Conflict(message=None, details=None, response=None, request_id=None, url=None, method=None, http_status=None)[source]¶

Bases: ironicclient.common.apiclient.exceptions.HTTPClientError

HTTP 409 - Conflict.

Indicates that the request could not be processed because of conflict in the request, such as an edit conflict.

http_status = 409¶

message = 'Conflict'¶

exception ironicclient.common.apiclient.exceptions.ConnectionError[source]¶

Bases: ironicclient.common.apiclient.exceptions.ClientException

Cannot connect to API service.

exception ironicclient.common.apiclient.exceptions.ConnectionRefused[source]¶

Bases: ironicclient.common.apiclient.exceptions.ConnectionError

Connection refused while trying to connect to API service.

exception ironicclient.common.apiclient.exceptions.EndpointException[source]¶

Bases: ironicclient.common.apiclient.exceptions.ClientException

Something is rotten in Service Catalog.

exception ironicclient.common.apiclient.exceptions.EndpointNotFound[source]¶

Bases: ironicclient.common.apiclient.exceptions.EndpointException

Could not find requested endpoint in Service Catalog.

exception ironicclient.common.apiclient.exceptions.ExpectationFailed(message=None, details=None, response=None, request_id=None, url=None, method=None, http_status=None)[source]¶

Bases: ironicclient.common.apiclient.exceptions.HTTPClientError

HTTP 417 - Expectation Failed.

The server cannot meet the requirements of the Expect request-header field.

http_status = 417¶

message = 'Expectation Failed'¶

exception ironicclient.common.apiclient.exceptions.Forbidden(message=None, details=None, response=None, request_id=None, url=None, method=None, http_status=None)[source]¶

Bases: ironicclient.common.apiclient.exceptions.HTTPClientError

HTTP 403 - Forbidden.

The request was a valid request, but the server is refusing to respond to it.

http_status = 403¶

message = 'Forbidden'¶

exception ironicclient.common.apiclient.exceptions.GatewayTimeout(message=None, details=None, response=None, request_id=None, url=None, method=None, http_status=None)[source]¶

Bases: ironicclient.common.apiclient.exceptions.HttpServerError

HTTP 504 - Gateway Timeout.

The server was acting as a gateway or proxy and did not receive a timely response from the upstream server.

http_status = 504¶

message = 'Gateway Timeout'¶

exception ironicclient.common.apiclient.exceptions.Gone(message=None, details=None, response=None, request_id=None, url=None, method=None, http_status=None)[source]¶

Bases: ironicclient.common.apiclient.exceptions.HTTPClientError

HTTP 410 - Gone.

Indicates that the resource requested is no longer available and will not be available again.

http_status = 410¶

message = 'Gone'¶

exception ironicclient.common.apiclient.exceptions.HTTPClientError(message=None, details=None, response=None, request_id=None, url=None, method=None, http_status=None)[source]¶

Bases: ironicclient.common.apiclient.exceptions.HttpError

Client-side HTTP error.

Exception for cases in which the client seems to have erred.

message = 'HTTP Client Error'¶

exception ironicclient.common.apiclient.exceptions.HTTPRedirection(message=None, details=None, response=None, request_id=None, url=None, method=None, http_status=None)[source]¶

Bases: ironicclient.common.apiclient.exceptions.HttpError

HTTP Redirection.

message = 'HTTP Redirection'¶

exception ironicclient.common.apiclient.exceptions.HttpError(message=None, details=None, response=None, request_id=None, url=None, method=None, http_status=None)[source]¶

Bases: ironicclient.common.apiclient.exceptions.ClientException

The base exception class for all HTTP exceptions.

http_status = 0¶

message = 'HTTP Error'¶

exception ironicclient.common.apiclient.exceptions.HttpNotImplemented(message=None, details=None, response=None, request_id=None, url=None, method=None, http_status=None)[source]¶

Bases: ironicclient.common.apiclient.exceptions.HttpServerError

HTTP 501 - Not Implemented.

The server either does not recognize the request method, or it lacks the ability to fulfill the request.

http_status = 501¶

message = 'Not Implemented'¶

exception ironicclient.common.apiclient.exceptions.HttpServerError(message=None, details=None, response=None, request_id=None, url=None, method=None, http_status=None)[source]¶

Bases: ironicclient.common.apiclient.exceptions.HttpError

Server-side HTTP error.

Exception for cases in which the server is aware that it has erred or is incapable of performing the request.

message = 'HTTP Server Error'¶

exception ironicclient.common.apiclient.exceptions.HttpVersionNotSupported(message=None, details=None, response=None, request_id=None, url=None, method=None, http_status=None)[source]¶

Bases: ironicclient.common.apiclient.exceptions.HttpServerError

HTTP 505 - HttpVersion Not Supported.

The server does not support the HTTP protocol version used in the request.

http_status = 505¶

message = 'HTTP Version Not Supported'¶

exception ironicclient.common.apiclient.exceptions.InternalServerError(message=None, details=None, response=None, request_id=None, url=None, method=None, http_status=None)[source]¶

Bases: ironicclient.common.apiclient.exceptions.HttpServerError

HTTP 500 - Internal Server Error.

A generic error message, given when no more specific message is suitable.

http_status = 500¶

message = 'Internal Server Error'¶

exception ironicclient.common.apiclient.exceptions.LengthRequired(message=None, details=None, response=None, request_id=None, url=None, method=None, http_status=None)[source]¶

Bases: ironicclient.common.apiclient.exceptions.HTTPClientError

HTTP 411 - Length Required.

The request did not specify the length of its content, which is required by the requested resource.

http_status = 411¶

message = 'Length Required'¶

exception ironicclient.common.apiclient.exceptions.MethodNotAllowed(message=None, details=None, response=None, request_id=None, url=None, method=None, http_status=None)[source]¶

Bases: ironicclient.common.apiclient.exceptions.HTTPClientError

HTTP 405 - Method Not Allowed.

A request was made of a resource using a request method not supported by that resource.

http_status = 405¶

message = 'Method Not Allowed'¶

exception ironicclient.common.apiclient.exceptions.MultipleChoices(message=None, details=None, response=None, request_id=None, url=None, method=None, http_status=None)[source]¶

Bases: ironicclient.common.apiclient.exceptions.HTTPRedirection

HTTP 300 - Multiple Choices.

Indicates multiple options for the resource that the client may follow.

http_status = 300¶

message = 'Multiple Choices'¶

exception ironicclient.common.apiclient.exceptions.NoUniqueMatch[source]¶

Bases: ironicclient.common.apiclient.exceptions.ClientException

Multiple entities found instead of one.

exception ironicclient.common.apiclient.exceptions.NotAcceptable(message=None, details=None, response=None, request_id=None, url=None, method=None, http_status=None)[source]¶

Bases: ironicclient.common.apiclient.exceptions.HTTPClientError

HTTP 406 - Not Acceptable.

The requested resource is only capable of generating content not acceptable according to the Accept headers sent in the request.

http_status = 406¶

message = 'Not Acceptable'¶

exception ironicclient.common.apiclient.exceptions.NotFound(message=None, details=None, response=None, request_id=None, url=None, method=None, http_status=None)[source]¶

Bases: ironicclient.common.apiclient.exceptions.HTTPClientError

HTTP 404 - Not Found.

The requested resource could not be found but may be available again in the future.

http_status = 404¶

message = 'Not Found'¶

exception ironicclient.common.apiclient.exceptions.PaymentRequired(message=None, details=None, response=None, request_id=None, url=None, method=None, http_status=None)[source]¶

Bases: ironicclient.common.apiclient.exceptions.HTTPClientError

HTTP 402 - Payment Required.

Reserved for future use.

http_status = 402¶

message = 'Payment Required'¶

exception ironicclient.common.apiclient.exceptions.PreconditionFailed(message=None, details=None, response=None, request_id=None, url=None, method=None, http_status=None)[source]¶

Bases: ironicclient.common.apiclient.exceptions.HTTPClientError

HTTP 412 - Precondition Failed.

The server does not meet one of the preconditions that the requester put on the request.

http_status = 412¶

message = 'Precondition Failed'¶

exception ironicclient.common.apiclient.exceptions.ProxyAuthenticationRequired(message=None, details=None, response=None, request_id=None, url=None, method=None, http_status=None)[source]¶

Bases: ironicclient.common.apiclient.exceptions.HTTPClientError

HTTP 407 - Proxy Authentication Required.

The client must first authenticate itself with the proxy.

http_status = 407¶

message = 'Proxy Authentication Required'¶

exception ironicclient.common.apiclient.exceptions.RequestEntityTooLarge(*args, **kwargs)[source]¶

Bases: ironicclient.common.apiclient.exceptions.HTTPClientError

HTTP 413 - Request Entity Too Large.

The request is larger than the server is willing or able to process.

http_status = 413¶

message = 'Request Entity Too Large'¶

exception ironicclient.common.apiclient.exceptions.RequestTimeout(message=None, details=None, response=None, request_id=None, url=None, method=None, http_status=None)[source]¶

Bases: ironicclient.common.apiclient.exceptions.HTTPClientError

HTTP 408 - Request Timeout.

The server timed out waiting for the request.

http_status = 408¶

message = 'Request Timeout'¶

exception ironicclient.common.apiclient.exceptions.RequestUriTooLong(message=None, details=None, response=None, request_id=None, url=None, method=None, http_status=None)[source]¶

Bases: ironicclient.common.apiclient.exceptions.HTTPClientError

HTTP 414 - Request-URI Too Long.

The URI provided was too long for the server to process.

http_status = 414¶

message = 'Request-URI Too Long'¶

exception ironicclient.common.apiclient.exceptions.RequestedRangeNotSatisfiable(message=None, details=None, response=None, request_id=None, url=None, method=None, http_status=None)[source]¶

Bases: ironicclient.common.apiclient.exceptions.HTTPClientError

HTTP 416 - Requested Range Not Satisfiable.

The client has asked for a portion of the file, but the server cannot supply that portion.

http_status = 416¶

message = 'Requested Range Not Satisfiable'¶

exception ironicclient.common.apiclient.exceptions.ServiceUnavailable(message=None, details=None, response=None, request_id=None, url=None, method=None, http_status=None)[source]¶

Bases: ironicclient.common.apiclient.exceptions.HttpServerError

HTTP 503 - Service Unavailable.

The server is currently unavailable.

http_status = 503¶

message = 'Service Unavailable'¶

exception ironicclient.common.apiclient.exceptions.Unauthorized(message=None, details=None, response=None, request_id=None, url=None, method=None, http_status=None)[source]¶

Bases: ironicclient.common.apiclient.exceptions.HTTPClientError

HTTP 401 - Unauthorized.

Similar to 403 Forbidden, but specifically for use when authentication is required and has failed or has not yet been provided.

http_status = 401¶

message = 'Unauthorized'¶

exception ironicclient.common.apiclient.exceptions.UnprocessableEntity(message=None, details=None, response=None, request_id=None, url=None, method=None, http_status=None)[source]¶

Bases: ironicclient.common.apiclient.exceptions.HTTPClientError

HTTP 422 - Unprocessable Entity.

The request was well-formed but was unable to be followed due to semantic errors.

http_status = 422¶

message = 'Unprocessable Entity'¶

exception ironicclient.common.apiclient.exceptions.UnsupportedMediaType(message=None, details=None, response=None, request_id=None, url=None, method=None, http_status=None)[source]¶

Bases: ironicclient.common.apiclient.exceptions.HTTPClientError

HTTP 415 - Unsupported Media Type.

The request entity has a media type which the server or resource does not support.

http_status = 415¶

message = 'Unsupported Media Type'¶

exception ironicclient.common.apiclient.exceptions.UnsupportedVersion[source]¶

Bases: ironicclient.common.apiclient.exceptions.ClientException

User is trying to use an unsupported version of the API.

exception ironicclient.common.apiclient.exceptions.ValidationError[source]¶

Bases: ironicclient.common.apiclient.exceptions.ClientException

Error in validation on API client side.

ironicclient.common.apiclient.exceptions.from_response(response, method, url)[source]¶

Returns an instance of HttpError or subclass based on response.

Parameters:	response – instance of requests.Response class method – HTTP method used for request url – URL used for request