pyrax
Python Bindings for the Rackspace Cloud
 All Classes Namespaces Files Functions Variables Properties
Public Member Functions | Static Public Attributes
CloudBlockStorageClient Class Reference

This is the primary class for interacting with Cloud Block Storage. More...

Inheritance diagram for CloudBlockStorageClient:
BaseClient FakeBlockStorageClient

List of all members.

Public Member Functions

def list_types
 Returns a list of all available volume types.
def list_snapshots
 Returns a list of all snapshots.
def attach_to_instance
 Attaches the volume to the specified instance at the mountpoint.
def detach
 Detaches the volume from whatever device it is attached to.
def delete_volume
 Deletes the volume.
def update
 Update the specified values on the specified volume.
def create_snapshot
 Creates a snapshot of the volume, with an optional name and description.
def get_snapshot
 Returns the snapshot with the specified snapshot ID value.
def delete_snapshot
 Deletes the snapshot.
def update_snapshot
 Update the specified values on the specified snapshot.

Static Public Attributes

string name = "Cloud Block Storage"

Detailed Description

This is the primary class for interacting with Cloud Block Storage.


Member Function Documentation

def attach_to_instance (   self,
  volume,
  instance,
  mountpoint 
)

Attaches the volume to the specified instance at the mountpoint.

def create_snapshot (   self,
  volume,
  name = None,
  description = None,
  force = False 
)

Creates a snapshot of the volume, with an optional name and description.

Normally snapshots will not happen if the volume is attached. To override this default behavior, pass force=True.

def delete_snapshot (   self,
  snapshot 
)

Deletes the snapshot.

def delete_volume (   self,
  volume,
  force = False 
)

Deletes the volume.

def detach (   self,
  volume 
)

Detaches the volume from whatever device it is attached to.

def get_snapshot (   self,
  snapshot 
)

Returns the snapshot with the specified snapshot ID value.

def list_snapshots (   self)

Returns a list of all snapshots.

def list_types (   self)

Returns a list of all available volume types.

def update (   self,
  volume,
  display_name = None,
  display_description = None 
)

Update the specified values on the specified volume.

You may specify one or more values to update.

def update_snapshot (   self,
  snapshot,
  display_name = None,
  display_description = None 
)

Update the specified values on the specified snapshot.

You may specify one or more values to update.


Member Data Documentation

string name = "Cloud Block Storage" [static]

Reimplemented from BaseClient.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Properties