cinderlib.objects module

class Connection(*args, **kwargs)

Bases: Object, LazyVolumeAttr

Cinderlib Connection info that maps to VolumeAttachment.

On Pike we don’t have the connector field on the VolumeAttachment ORM instance so we use the connection_info to store everything.

We’ll have a dictionary:

{‘conn’: connection info

‘connector’: connector dictionary ‘device’: result of connect_volume}

SIMPLE_JSON_IGNORE = ('volume',)

attach()

property attached

property backend

property conn_info

classmethod connect(volume, connector, **kwargs)

property connected

property connector

property connector_info

detach(force=False, ignore_errors=False, exc=None)

property device

device_attached(device)

disconnect(force=False)

extend()

classmethod get_by_id(connection_id)

property path

property protocol

save()

class KeyValue(key=None, value=None)

Bases: object

class LazyVolumeAttr(volume)

Bases: object

LAZY_PROPERTIES = ('volume',)

refresh()

property volume

class NamedObject(backend, **fields_data)

Bases: Object

property description

property name

property name_in_storage

class Object(backend, **fields_data)

Bases: object

Base class for our resource representation objects.

DEFAULT_FIELDS_VALUES = {}

LAZY_PROPERTIES = ()

SIMPLE_JSON_IGNORE = ()

backend_class

alias of Backend

property dump

property dumps

property json

property jsons

classmethod load(json_src, save=False)

static new_uuid()

classmethod setup(persistence_driver, backend_class, project_id, user_id, non_uuid_ids)

to_dict()

to_json(simplified=True)

to_jsons(simplified=True)

class Snapshot(volume, **kwargs)

Bases: NamedObject, LazyVolumeAttr

DEFAULT_FIELDS_VALUES = {'metadata': {}, 'status': 'creating'}

SIMPLE_JSON_IGNORE = ('volume',)

create()

create_volume(**new_vol_params)

delete()

classmethod get_by_id(snapshot_id)

classmethod get_by_name(snapshot_name)

save()

class Volume(backend_or_vol, pool_name=None, **kwargs)

Bases: NamedObject

DEFAULT_FIELDS_VALUES = {'admin_metadata': {}, 'attach_status': 'detached', 'glance_metadata': {}, 'metadata': {}, 'project_id': cinder.context.RequestContext.project_id, 'size': 1, 'status': 'creating', 'user_id': cinder.context.RequestContext.user_id}

LAZY_PROPERTIES = ('snapshots', 'connections')

SIMPLE_JSON_IGNORE = ('snapshots', 'volume_attachment')

attach()

cleanup()

clone(**new_vol_attrs)

connect(connector_dict, **ovo_fields)

property connections

create()

create_snapshot(name='', description='', **kwargs)

delete()

detach(force=False, ignore_errors=False)

disconnect(connection, force=False)

extend(size)

classmethod get_by_id(volume_id)

classmethod get_by_name(volume_name)

refresh()

save()

property snapshots

setup(persistence_driver, backend_class, project_id, user_id, non_uuid_ids)