common Package

clientmanager Module

commandmanager Module

exceptions Module

Exception definitions.

exception openstackclient.common.exceptions.AuthorizationFailure

Bases: exceptions.Exception

exception openstackclient.common.exceptions.BadRequest(code, message=None, details=None)

Bases: openstackclient.common.exceptions.ClientException

HTTP 400 - Bad request: you sent some malformed data.

http_status = 400
message = 'Bad request'
exception openstackclient.common.exceptions.ClientException(code, message=None, details=None)

Bases: exceptions.Exception

The base exception class for all exceptions this library raises.

exception openstackclient.common.exceptions.CommandError

Bases: exceptions.Exception

exception openstackclient.common.exceptions.Conflict(code, message=None, details=None)

Bases: openstackclient.common.exceptions.ClientException

HTTP 409 - Conflict

http_status = 409
message = 'Conflict'
exception openstackclient.common.exceptions.EndpointNotFound

Bases: exceptions.Exception

Could not find Service or Region in Service Catalog.

exception openstackclient.common.exceptions.Forbidden(code, message=None, details=None)

Bases: openstackclient.common.exceptions.ClientException

HTTP 403 - Forbidden: not authorized to access to this resource.

http_status = 403
message = 'Forbidden'
exception openstackclient.common.exceptions.HTTPNotImplemented(code, message=None, details=None)

Bases: openstackclient.common.exceptions.ClientException

HTTP 501 - Not Implemented: server does not support this operation.

http_status = 501
message = 'Not Implemented'
exception openstackclient.common.exceptions.NoTokenLookupException

Bases: exceptions.Exception

This does not support looking up endpoints from an existing token.

exception openstackclient.common.exceptions.NotFound(code, message=None, details=None)

Bases: openstackclient.common.exceptions.ClientException

HTTP 404 - Not found

http_status = 404
message = 'Not found'
exception openstackclient.common.exceptions.OverLimit(code, message=None, details=None)

Bases: openstackclient.common.exceptions.ClientException

HTTP 413 - Over limit: reached the API limits for this time period.

http_status = 413
message = 'Over limit'
exception openstackclient.common.exceptions.Unauthorized(code, message=None, details=None)

Bases: openstackclient.common.exceptions.ClientException

HTTP 401 - Unauthorized: bad credentials.

http_status = 401
message = 'Unauthorized'
exception openstackclient.common.exceptions.UnsupportedVersion

Bases: exceptions.Exception

The user is trying to use an unsupported version of the API

openstackclient.common.exceptions.from_response(response, body)

Return an instance of a ClientException based on an httplib2 response.

Usage:

resp, body = http.request(...)
if resp.status != 200:
    raise exception_from_response(resp, body)

extension Module

limits Module

module Module

parseractions Module

argparse Custom Actions

class openstackclient.common.parseractions.KeyValueAction(option_strings, dest, nargs=None, const=None, default=None, type=None, choices=None, required=False, help=None, metavar=None)

Bases: argparse.Action

A custom action to parse arguments as key=value pairs

Ensures that dest is a dict

class openstackclient.common.parseractions.RangeAction(option_strings, dest, nargs=None, const=None, default=None, type=None, choices=None, required=False, help=None, metavar=None)

Bases: argparse.Action

A custom action to parse a single value or a range of values

Parses single integer values or a range of integer values delimited by a colon and returns a tuple of integers: ‘4’ sets dest to (4, 4) ‘6:9’ sets dest to (6, 9)

quota Module

timing Module

utils Module