org.ovirt.engine.core.vdsbroker.irsbroker

Interface IIrsBroker

public interface IIrsBroker

Method Summary

Methods

Modifier and Type	Method and Description
Guid	copyImage(Guid srcImageId) Copy an Image
Guid	create(String imageName, long imageSizeInBytes, int imageType) create a new Image
Guid	createSnapshot(Guid srcImageId) Create a snapshot of an image
void	destroy(Guid imageId) Destroy an Image
DiskImage	getImageInfo(Guid imageId) Gets Information about the Image
Guid	getParent(Guid imageId) Gets the parent image
Guid[]	listImageIds() Lists all images on IRS
void	mergeSnapshots(Guid imageId1, Guid imageId2) Merge 2 snapshots into one
void	setImageDescr(Guid imageId, String descr) Sets the image description

Method Detail

create

Guid create(String imageName,
          long imageSizeInBytes,
          int imageType)

create a new Image

Parameters:

imageName - string Name

imageSizeInBytes - int number of bytes

imageType - int, for future use

Returns:

Guid VdcDAL.IrsBroker.IRSProtocolException VdcDAL.IrsBroker.IRSNetworkException VdcDAL.IrsBrokerIRSErrorException. System.Exception

listImageIds

Guid[] listImageIds()

Lists all images on IRS

Returns:

Guid[] VdcDAL.IrsBroker.IRSProtocolException VdcDAL.IrsBroker.IRSNetworkException VdcDAL.IrsBrokerIRSErrorException. System.Exception

destroy

void destroy(Guid imageId)

Destroy an Image

Parameters:

imageId - Guid ImageId VdcDAL.IrsBroker.IRSProtocolException VdcDAL.IrsBroker.IRSNetworkException VdcDAL.IrsBrokerIRSErrorException. System.Exception

getImageInfo

DiskImage getImageInfo(Guid imageId)

Gets Information about the Image

Parameters:

imageId - Guid

Returns:

DislImage VdcDAL.IrsBroker.IRSProtocolException VdcDAL.IrsBroker.IRSNetworkException VdcDAL.IrsBrokerIRSErrorException. System.Exception

copyImage

Guid copyImage(Guid srcImageId)

Copy an Image

Parameters:

srcImageId -

Returns:

Guid - imageId of the copied image VdcDAL.IrsBroker.IRSProtocolException VdcDAL.IrsBroker.IRSNetworkException VdcDAL.IrsBrokerIRSErrorException. System.Exception

createSnapshot

Guid createSnapshot(Guid srcImageId)

Create a snapshot of an image

Parameters:

srcImageId - Guid

Returns:

Guid - the id of the new created snapshot VdcDAL.IrsBroker.IRSProtocolException VdcDAL.IrsBroker.IRSNetworkException VdcDAL.IrsBrokerIRSErrorException. System.Exception

getParent

Guid getParent(Guid imageId)

Gets the parent image

Parameters:

imageId - Guid - the child image

Returns:

Guid - the image id of the parent image VdcDAL.IrsBroker.IRSProtocolException VdcDAL.IrsBroker.IRSNetworkException VdcDAL.IrsBrokerIRSErrorException. System.Exception

mergeSnapshots

void mergeSnapshots(Guid imageId1,
                  Guid imageId2)

Merge 2 snapshots into one

Parameters:

imageId1 - Guid - id of first mage

imageId2 - Guid - id of second image VdcDAL.IrsBroker.IRSProtocolException VdcDAL.IrsBroker.IRSNetworkException VdcDAL.IrsBrokerIRSErrorException. System.Exception

setImageDescr

void setImageDescr(Guid imageId,
                 String descr)

Sets the image description

Parameters:

imageId - Guid Image id

descr - string description VdcDAL.IrsBroker.IRSProtocolException VdcDAL.IrsBroker.IRSNetworkException VdcDAL.IrsBrokerIRSErrorException. System.Exception