The cinder.api.contrib.snapshot_manage Module

The cinder.api.contrib.snapshot_manage Module

class SnapshotManageController(*args, **kwargs)

Bases: cinder.api.openstack.wsgi.Controller

The /os-snapshot-manage controller for the OpenStack API.

create(req, body)

Instruct Cinder to manage a storage snapshot object.

Manages an existing backend storage snapshot object (e.g. a Linux logical volume or a SAN disk) by creating the Cinder objects required to manage it, and possibly renaming the backend storage snapshot object (driver dependent).

From an API perspective, this operation behaves very much like a snapshot creation operation.

Required HTTP Body:

{
  "snapshot":
  {
    "volume_id": "<Cinder volume already exists in volume backend>",
    "ref":
       "<Driver-specific reference to the existing storage object>"
  }
}

See the appropriate Cinder drivers’ implementations of the manage_snapshot method to find out the accepted format of ‘ref’. For example,in LVM driver, it will be the logic volume name of snapshot which you want to manage.

This API call will return with an error if any of the above elements are missing from the request, or if the ‘volume_id’ element refers to a cinder volume that could not be found.

The snapshot will later enter the error state if it is discovered that ‘ref’ is bad.

Optional elements to ‘snapshot’ are:

name           A name for the new snapshot.
description    A description for the new snapshot.
metadata       Key/value pairs to be associated with the new snapshot.
detail(req)

Returns a detailed list of snapshots available to manage.

index(req)

Returns a summary list of snapshots available to manage.

wsgi_actions = {}
wsgi_extensions = [('index', None), ('detail', None)]
class Snapshot_manage(ext_mgr)

Bases: cinder.api.extensions.ExtensionDescriptor

Allows existing backend storage to be ‘managed’ by Cinder.

alias = 'os-snapshot-manage'
get_resources()
name = 'SnapshotManage'
updated = '2014-12-31T00:00:00+00:00'
Creative Commons Attribution 3.0 License

Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.