com.ceph.rbd

Class Rbd

java.lang.Object

com.ceph.rbd.Rbd

public class Rbd
extends Object

Constructor Summary

Constructors

Constructor and Description
Rbd(IoCTX io)

Method Summary

Modifier and Type	Method and Description
void	clone(String parentImage, String parentSnap, IoCTX childIo, String childName, long features, int order) Clone a RBD image
void	clone(String parentImage, String parentSnap, IoCTX childIo, String childName, long features, int order, long stripe_unit, long stripe_count) Clone a RBD image
void	close(RbdImage image) Close a RBD image
void	copy(RbdImage sourceImage, RbdImage destImage) Copy a RBD image
void	create(String name, long size) Create a new RBD image
void	create(String name, long size, int order) Create a new RBD image
void	create(String name, long size, long features) Create a new RBD v2 image
void	create(String name, long size, long features, int order) Create a new RBD v2 image
void	create(String name, long size, long features, int order, long stripe_unit, long stripe_count) Create a new RBD v2 image
static int[]	getVersion() Get the librbd version
String[]	list() List all RBD images in this pool
String[]	list(int initialBufferSize) List all RBD images in this pool
RbdImage	open(String name) Open a RBD image
RbdImage	open(String name, String snapName) Open a RBD image with a specific snapshot
RbdImage	openReadOnly(String name) Open a RBD image read only
RbdImage	openReadOnly(String name, String snapName) Open a RBD image with a specific snapshot read only
void	remove(String name) Remove a RBD image
void	rename(String srcName, String destName) Rename a RBD image

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Rbd

public Rbd(IoCTX io)

Method Detail

getVersion

public static int[] getVersion()

Get the librbd version

Returns:

a int array with the minor, major and extra version

create

public void create(String name,
                   long size,
                   int order)
            throws RbdException

Create a new RBD image

Parameters:

name - The name of the new image

size - The size of the new image in bytes

order - Object/block size, as a power of two

Throws:

RbdException

create

public void create(String name,
                   long size)
            throws RbdException

Create a new RBD image

Parameters:

name - The name of the new image

size - The size of the new image in bytes

Throws:

RbdException

create

public void create(String name,
                   long size,
                   long features,
                   int order)
            throws RbdException

Create a new RBD v2 image

Parameters:

name - The name of the new image

size - The size of the new image in bytes

features - Initial feature bits

order - Object/block size, as a power of two

Throws:

RbdException

create

public void create(String name,
                   long size,
                   long features)
            throws RbdException

Create a new RBD v2 image

Parameters:

name - The name of the new image

size - The size of the new image in bytes

features - Initial feature bits

Throws:

RbdException

create

public void create(String name,
                   long size,
                   long features,
                   int order,
                   long stripe_unit,
                   long stripe_count)
            throws RbdException

Create a new RBD v2 image

Parameters:

name - The name of the new image

size - The size of the new image in bytes

features - Initial feature bits

order - Object/block size, as a power of two

stripe_unit - Stripe unit size, in bytes.

stripe_count - Number of objects to stripe over before looping

Throws:

RbdException

remove

public void remove(String name)
            throws RbdException

Remove a RBD image

Parameters:

name - The name of the image

Throws:

RbdException

rename

public void rename(String srcName,
                   String destName)
            throws RbdException

Rename a RBD image

Parameters:

srcName - The source name

destName - The new name for the image

Throws:

RbdException

list

public String[] list()
              throws RbdException

List all RBD images in this pool

Returns:

String[]

Throws:

RbdException

list

public String[] list(int initialBufferSize)
              throws RbdException

List all RBD images in this pool

Parameters:

initialBufferSize - Initial size of the byte buffer holding image names

Returns:

String[] Array of image names in the pool

Throws:

RbdException

open

public RbdImage open(String name)
              throws RbdException

Open a RBD image

Parameters:

name - The name of the image you want to open

Returns:

RbdImage

Throws:

RbdException

open

public RbdImage open(String name,
                     String snapName)
              throws RbdException

Open a RBD image with a specific snapshot

Parameters:

name - The name of the image you want to open

snapName - The name of the snapshot to open

Returns:

RbdImage

Throws:

RbdException

openReadOnly

public RbdImage openReadOnly(String name)
                      throws RbdException

Open a RBD image read only

Parameters:

name - The name of the image you want to open

Returns:

RbdImage

Throws:

RbdException

openReadOnly

public RbdImage openReadOnly(String name,
                             String snapName)
                      throws RbdException

Open a RBD image with a specific snapshot read only

Parameters:

name - The name of the image you want to open

snapName - The name of the snapshot to open

Returns:

RbdImage

Throws:

RbdException

close

public void close(RbdImage image)
           throws RbdException

Close a RBD image

Parameters:

image - The RbdImage object

Throws:

RbdException

clone

public void clone(String parentImage,
                  String parentSnap,
                  IoCTX childIo,
                  String childName,
                  long features,
                  int order,
                  long stripe_unit,
                  long stripe_count)
           throws RbdException

Clone a RBD image

Parameters:

parentImage - The name of the parent image

parentSnap - The snapshot of the parent image (has to be protected)

childIo - The IoCTX for the child image

childName - The name for the child image

features - The RBD features

order - Object/block size, as a power of two

stripe_unit - Stripe unit size, in bytes.

stripe_count - Number of objects to stripe over before looping

Throws:

RbdException

clone

public void clone(String parentImage,
                  String parentSnap,
                  IoCTX childIo,
                  String childName,
                  long features,
                  int order)
           throws RbdException

Clone a RBD image

Parameters:

parentImage - The name of the parent image

parentSnap - The snapshot of the parent image (has to be protected)

childIo - The IoCTX for the child image

childName - The name for the child image

features - The RBD features

order - Object/block size, as a power of two

Throws:

RbdException

copy

public void copy(RbdImage sourceImage,
                 RbdImage destImage)
          throws RbdException

Copy a RBD image

Parameters:

sourceImage - The source RbdImage

destImage - The destination RbdImage

Throws:

RbdException