pyds8k package

Subpackages

• pyds8k.client package
  • Subpackages
    • pyds8k.client.ds8k package
      • Subpackages
      • Module contents
  • Submodules
  • pyds8k.client.exceptions module
  • Module contents
• pyds8k.resources.ds8k package
  • Subpackages
    • pyds8k.resources.ds8k.v1 package
      • Subpackages
      • Submodules
      • pyds8k.resources.ds8k.v1.encryption_groups module
      • pyds8k.resources.ds8k.v1.eserep module
      • pyds8k.resources.ds8k.v1.events module
      • pyds8k.resources.ds8k.v1.flashcopy module
      • pyds8k.resources.ds8k.v1.host_ports module
      • pyds8k.resources.ds8k.v1.hosts module
      • pyds8k.resources.ds8k.v1.io_enclosures module
      • pyds8k.resources.ds8k.v1.ioports module
      • pyds8k.resources.ds8k.v1.lss module
      • pyds8k.resources.ds8k.v1.mappings module
      • pyds8k.resources.ds8k.v1.marrays module
      • pyds8k.resources.ds8k.v1.nodes module
      • pyds8k.resources.ds8k.v1.pools module
      • pyds8k.resources.ds8k.v1.pprc module
      • pyds8k.resources.ds8k.v1.systems module
      • pyds8k.resources.ds8k.v1.tserep module
      • pyds8k.resources.ds8k.v1.users module
      • pyds8k.resources.ds8k.v1.volumes module
      • Module contents
  • Module contents

Submodules

pyds8k.exceptions module

Exception definitions.

exception pyds8k.exceptions.BadRequest(code, message=None, detail='', origin_data=None)

Bases: ClientError

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

reason_phrase = 'Bad Request'

status_code = '400'

exception pyds8k.exceptions.BaseRestError

Bases: Exception

exception pyds8k.exceptions.ClientError(code, message=None, detail='', origin_data=None)

Bases: ClientException

HTTP 4xx - Client Error

reason_phrase = 'Client Error'

status_code = '4xx'

exception pyds8k.exceptions.ClientException(code, message=None, detail='', origin_data=None)

Bases: Exception

The base exception class for all HTTP client or server errors.

exception pyds8k.exceptions.Conflict(code, message=None, detail='', origin_data=None)

Bases: ClientError

HTTP 409 - Conflict

reason_phrase = 'Conflict'

status_code = '409'

exception pyds8k.exceptions.ConnectionError

Bases: Exception

Could not open a connection to the API service.

exception pyds8k.exceptions.FieldReadOnly(field_name)

Bases: Exception

Field is read only.

exception pyds8k.exceptions.Forbidden(code, message=None, detail='', origin_data=None)

Bases: ClientError

HTTP 403 - Forbidden: your credentials don’t give you access to this resource.

reason_phrase = 'Forbidden'

status_code = '403'

exception pyds8k.exceptions.GatewayTimeout(code, message=None, detail='', origin_data=None)

Bases: ServerError

HTTP 504 - Gateway Timeout

reason_phrase = 'Gateway Timeout'

status_code = '504'

exception pyds8k.exceptions.IDMissingError

Bases: Exception

The id field is missing or None.

exception pyds8k.exceptions.InternalServerError(code, message=None, detail='', origin_data=None)

Bases: ServerError

HTTP 500 - Internal Server Error: The server encountered an unexpected condition which prevented it from fulfilling the request.

reason_phrase = 'Internal Server Error'

status_code = '500'

exception pyds8k.exceptions.InvalidArgumentError(reason)

Bases: Exception

exception pyds8k.exceptions.InvalidMethodForCreate(method)

Bases: Exception

exception pyds8k.exceptions.MethodNotAllowed(code, message=None, detail='', origin_data=None)

Bases: ClientError

HTTP 405 - Method Not Allowed

reason_phrase = 'Method Not Allowed'

status_code = '405'

exception pyds8k.exceptions.NotFound(code, message=None, detail='', origin_data=None)

Bases: ClientError

HTTP 404 - Not found

reason_phrase = 'Not Found'

status_code = '404'

exception pyds8k.exceptions.OperationNotAllowed(operation_name, resource_name='')

Bases: Exception

The operation performed on the resource is not allowed.

exception pyds8k.exceptions.RepresentationNotFoundError

Bases: Exception

Can not find the representation

exception pyds8k.exceptions.RepresentationParseError

Bases: Exception

Can not get the representation

exception pyds8k.exceptions.ResponseBodyMissingError

Bases: Exception

The response body is missing.

exception pyds8k.exceptions.ServerError(code, message=None, detail='', origin_data=None)

Bases: ClientException

HTTP 5xx - Server Error

reason_phrase = 'Server Error'

status_code = '5xx'

exception pyds8k.exceptions.ServiceUnavailable(code, message=None, detail='', origin_data=None)

Bases: ServerError

HTTP 503 - Service Unavailable

reason_phrase = 'Service Unavailable'

status_code = '503'

exception pyds8k.exceptions.Timeout(url)

Bases: Exception

The request timed out.

exception pyds8k.exceptions.URLMissingError

Bases: Exception

The URL is missing.

exception pyds8k.exceptions.URLNotSpecifiedError

Bases: Exception

The URL is not specified.

exception pyds8k.exceptions.URLParseError

Bases: Exception

Can not get the URL

exception pyds8k.exceptions.Unauthorized(code, message=None, detail='', origin_data=None)

Bases: ClientError

HTTP 401 - Unauthorized: bad credentials.

reason_phrase = 'Unauthorized'

status_code = '401'

exception pyds8k.exceptions.UnsupportedMediaType(code, message=None, detail='', origin_data=None)

Bases: ClientError

HTTP 415 - Unsupported Media Type

reason_phrase = 'Unsupported Media Type'

status_code = '415'

pyds8k.exceptions.raise_error(response, body, service_type='')

Return an instance of an ClientException or subclass based on an requests response.

Module contents

IBM DS8K CLI Client Module

module

pyds8k

pyds8k.get_version_string()

Current version of Client.