com.xensource.xenapi

Class VDI

java.lang.Object

com.xensource.xenapi.XenAPIObject

com.xensource.xenapi.VDI

public class VDI
extends XenAPIObject

A virtual disk image First published in XenServer 4.0.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	VDI.Record Represents all the fields in a VDI

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	ref The XenAPI reference (OpaqueRef) to this object.

Method Summary

Methods

Modifier and Type	Method and Description
void	addTags(Connection c, java.lang.String value) Add the given value to the tags field of the given VDI.
void	addToOtherConfig(Connection c, java.lang.String key, java.lang.String value) Add the given key-value pair to the other_config field of the given VDI.
void	addToSmConfig(Connection c, java.lang.String key, java.lang.String value) Add the given key-value pair to the sm_config field of the given VDI.
void	addToXenstoreData(Connection c, java.lang.String key, java.lang.String value) Add the given key-value pair to the xenstore_data field of the given VDI.
VDI	copy(Connection c, SR sr) Copy either a full VDI or the block differences between two VDIs into either a fresh VDI or an existing VDI.
VDI	copy(Connection c, SR sr, VDI baseVdi, VDI intoVdi) Copy either a full VDI or the block differences between two VDIs into either a fresh VDI or an existing VDI.
Task	copyAsync(Connection c, SR sr) Copy either a full VDI or the block differences between two VDIs into either a fresh VDI or an existing VDI.
Task	copyAsync(Connection c, SR sr, VDI baseVdi, VDI intoVdi) Copy either a full VDI or the block differences between two VDIs into either a fresh VDI or an existing VDI.
static VDI	create(Connection c, VDI.Record record) Create a new VDI instance, and return its handle.
static Task	createAsync(Connection c, VDI.Record record) Create a new VDI instance, and return its handle.
VDI	createClone(Connection c, java.util.Map<java.lang.String,java.lang.String> driverParams) Take an exact copy of the VDI and return a reference to the new disk.
Task	createCloneAsync(Connection c, java.util.Map<java.lang.String,java.lang.String> driverParams) Take an exact copy of the VDI and return a reference to the new disk.
void	dataDestroy(Connection c) Delete the data of the snapshot VDI, but keep its changed block tracking metadata.
Task	dataDestroyAsync(Connection c) Delete the data of the snapshot VDI, but keep its changed block tracking metadata.
void	destroy(Connection c) Destroy the specified VDI instance.
Task	destroyAsync(Connection c) Destroy the specified VDI instance.
void	disableCbt(Connection c) Disable changed block tracking for the VDI.
Task	disableCbtAsync(Connection c) Disable changed block tracking for the VDI.
void	enableCbt(Connection c) Enable changed block tracking for the VDI.
Task	enableCbtAsync(Connection c) Enable changed block tracking for the VDI.
boolean	equals(java.lang.Object obj) If obj is a VDI, compares XenAPI references for equality.
void	forget(Connection c) Removes a VDI record from the database First published in XenServer 4.0.
Task	forgetAsync(Connection c) Removes a VDI record from the database First published in XenServer 4.0.
static java.util.Set<VDI>	getAll(Connection c) Return a list of all the VDIs known to the system.
java.lang.Boolean	getAllowCaching(Connection c) Get the allow_caching field of the given VDI.
java.util.Set<Types.VdiOperations>	getAllowedOperations(Connection c) Get the allowed_operations field of the given VDI.
static java.util.Map<VDI,VDI.Record>	getAllRecords(Connection c) Return a map of VDI references to VDI records for all VDIs known to the system.
static java.util.Set<VDI>	getByNameLabel(Connection c, java.lang.String label) Get all the VDI instances with the given label.
static VDI	getByUuid(Connection c, java.lang.String uuid) Get a reference to the VDI instance with the specified UUID.
java.lang.Boolean	getCbtEnabled(Connection c) Get the cbt_enabled field of the given VDI.
java.util.Set<Crashdump>	getCrashDumps(Connection c) Get the crash_dumps field of the given VDI.
java.util.Map<java.lang.String,Types.VdiOperations>	getCurrentOperations(Connection c) Get the current_operations field of the given VDI.
java.lang.Boolean	getIsASnapshot(Connection c) Get the is_a_snapshot field of the given VDI.
java.lang.Boolean	getIsToolsIso(Connection c) Get the is_tools_iso field of the given VDI.
java.lang.String	getLocation(Connection c) Get the location field of the given VDI.
java.lang.Boolean	getManaged(Connection c) Get the managed field of the given VDI.
java.lang.Boolean	getMetadataLatest(Connection c) Get the metadata_latest field of the given VDI.
Pool	getMetadataOfPool(Connection c) Get the metadata_of_pool field of the given VDI.
java.lang.Boolean	getMissing(Connection c) Get the missing field of the given VDI.
java.lang.String	getNameDescription(Connection c) Get the name/description field of the given VDI.
java.lang.String	getNameLabel(Connection c) Get the name/label field of the given VDI.
java.util.Set<VdiNbdServerInfo.Record>	getNbdInfo(Connection c) Get details specifying how to access this VDI via a Network Block Device server.
Types.OnBoot	getOnBoot(Connection c) Get the on_boot field of the given VDI.
java.util.Map<java.lang.String,java.lang.String>	getOtherConfig(Connection c) Get the other_config field of the given VDI.
VDI	getParent(Connection c) Deprecated.
java.lang.Long	getPhysicalUtilisation(Connection c) Get the physical_utilisation field of the given VDI.
java.lang.Boolean	getReadOnly(Connection c) Get the read_only field of the given VDI.
VDI.Record	getRecord(Connection c) Get a record containing the current state of the given VDI.
java.lang.Boolean	getSharable(Connection c) Get the sharable field of the given VDI.
java.util.Map<java.lang.String,java.lang.String>	getSmConfig(Connection c) Get the sm_config field of the given VDI.
VDI	getSnapshotOf(Connection c) Get the snapshot_of field of the given VDI.
java.util.Set<VDI>	getSnapshots(Connection c) Get the snapshots field of the given VDI.
java.util.Date	getSnapshotTime(Connection c) Get the snapshot_time field of the given VDI.
SR	getSR(Connection c) Get the SR field of the given VDI.
java.lang.Boolean	getStorageLock(Connection c) Get the storage_lock field of the given VDI.
java.util.Set<java.lang.String>	getTags(Connection c) Get the tags field of the given VDI.
Types.VdiType	getType(Connection c) Get the type field of the given VDI.
java.lang.String	getUuid(Connection c) Get the uuid field of the given VDI.
java.util.Set<VBD>	getVBDs(Connection c) Get the VBDs field of the given VDI.
java.lang.Long	getVirtualSize(Connection c) Get the virtual_size field of the given VDI.
java.util.Map<java.lang.String,java.lang.String>	getXenstoreData(Connection c) Get the xenstore_data field of the given VDI.
int	hashCode()
static VDI	introduce(Connection c, java.lang.String uuid, java.lang.String nameLabel, java.lang.String nameDescription, SR SR, Types.VdiType type, java.lang.Boolean sharable, java.lang.Boolean readOnly, java.util.Map<java.lang.String,java.lang.String> otherConfig, java.lang.String location, java.util.Map<java.lang.String,java.lang.String> xenstoreData, java.util.Map<java.lang.String,java.lang.String> smConfig) Create a new VDI record in the database only First published in XenServer 4.1.
static VDI	introduce(Connection c, java.lang.String uuid, java.lang.String nameLabel, java.lang.String nameDescription, SR SR, Types.VdiType type, java.lang.Boolean sharable, java.lang.Boolean readOnly, java.util.Map<java.lang.String,java.lang.String> otherConfig, java.lang.String location, java.util.Map<java.lang.String,java.lang.String> xenstoreData, java.util.Map<java.lang.String,java.lang.String> smConfig, java.lang.Boolean managed, java.lang.Long virtualSize, java.lang.Long physicalUtilisation, Pool metadataOfPool, java.lang.Boolean isASnapshot, java.util.Date snapshotTime, VDI snapshotOf) Create a new VDI record in the database only First published in XenServer 4.1.
static Task	introduceAsync(Connection c, java.lang.String uuid, java.lang.String nameLabel, java.lang.String nameDescription, SR SR, Types.VdiType type, java.lang.Boolean sharable, java.lang.Boolean readOnly, java.util.Map<java.lang.String,java.lang.String> otherConfig, java.lang.String location, java.util.Map<java.lang.String,java.lang.String> xenstoreData, java.util.Map<java.lang.String,java.lang.String> smConfig) Create a new VDI record in the database only First published in XenServer 4.1.
static Task	introduceAsync(Connection c, java.lang.String uuid, java.lang.String nameLabel, java.lang.String nameDescription, SR SR, Types.VdiType type, java.lang.Boolean sharable, java.lang.Boolean readOnly, java.util.Map<java.lang.String,java.lang.String> otherConfig, java.lang.String location, java.util.Map<java.lang.String,java.lang.String> xenstoreData, java.util.Map<java.lang.String,java.lang.String> smConfig, java.lang.Boolean managed, java.lang.Long virtualSize, java.lang.Long physicalUtilisation, Pool metadataOfPool, java.lang.Boolean isASnapshot, java.util.Date snapshotTime, VDI snapshotOf) Create a new VDI record in the database only First published in XenServer 4.1.
java.lang.String	listChangedBlocks(Connection c, VDI vdiTo) Compare two VDIs in 64k block increments and report which blocks differ.
Task	listChangedBlocksAsync(Connection c, VDI vdiTo) Compare two VDIs in 64k block increments and report which blocks differ.
Session	openDatabase(Connection c) Load the metadata found on the supplied VDI and return a session reference which can be used in API calls to query its contents.
Task	openDatabaseAsync(Connection c) Load the metadata found on the supplied VDI and return a session reference which can be used in API calls to query its contents.
VDI	poolMigrate(Connection c, SR sr, java.util.Map<java.lang.String,java.lang.String> options) Migrate a VDI, which may be attached to a running guest, to a different SR.
Task	poolMigrateAsync(Connection c, SR sr, java.util.Map<java.lang.String,java.lang.String> options) Migrate a VDI, which may be attached to a running guest, to a different SR.
java.lang.String	readDatabasePoolUuid(Connection c) Check the VDI cache for the pool UUID of the database on this VDI.
Task	readDatabasePoolUuidAsync(Connection c) Check the VDI cache for the pool UUID of the database on this VDI.
void	removeFromOtherConfig(Connection c, java.lang.String key) Remove the given key and its corresponding value from the other_config field of the given VDI.
void	removeFromSmConfig(Connection c, java.lang.String key) Remove the given key and its corresponding value from the sm_config field of the given VDI.
void	removeFromXenstoreData(Connection c, java.lang.String key) Remove the given key and its corresponding value from the xenstore_data field of the given VDI.
void	removeTags(Connection c, java.lang.String value) Remove the given value from the tags field of the given VDI.
void	resize(Connection c, java.lang.Long size) Resize the VDI.
Task	resizeAsync(Connection c, java.lang.Long size) Resize the VDI.
void	resizeOnline(Connection c, java.lang.Long size) Resize the VDI which may or may not be attached to running guests.
Task	resizeOnlineAsync(Connection c, java.lang.Long size) Resize the VDI which may or may not be attached to running guests.
void	setAllowCaching(Connection c, java.lang.Boolean value) Set the value of the allow_caching parameter.
Task	setAllowCachingAsync(Connection c, java.lang.Boolean value) Set the value of the allow_caching parameter.
void	setNameDescription(Connection c, java.lang.String value) Set the name description of the VDI.
Task	setNameDescriptionAsync(Connection c, java.lang.String value) Set the name description of the VDI.
void	setNameLabel(Connection c, java.lang.String value) Set the name label of the VDI.
Task	setNameLabelAsync(Connection c, java.lang.String value) Set the name label of the VDI.
void	setOnBoot(Connection c, Types.OnBoot value) Set the value of the on_boot parameter.
Task	setOnBootAsync(Connection c, Types.OnBoot value) Set the value of the on_boot parameter.
void	setOtherConfig(Connection c, java.util.Map<java.lang.String,java.lang.String> otherConfig) Set the other_config field of the given VDI.
void	setReadOnly(Connection c, java.lang.Boolean value) Sets the VDI's read_only field First published in XenServer 4.0.
void	setSharable(Connection c, java.lang.Boolean value) Sets the VDI's sharable field First published in XenServer 5.5.
void	setSmConfig(Connection c, java.util.Map<java.lang.String,java.lang.String> smConfig) Set the sm_config field of the given VDI.
void	setTags(Connection c, java.util.Set<java.lang.String> tags) Set the tags field of the given VDI.
void	setXenstoreData(Connection c, java.util.Map<java.lang.String,java.lang.String> xenstoreData) Set the xenstore_data field of the given VDI.
VDI	snapshot(Connection c, java.util.Map<java.lang.String,java.lang.String> driverParams) Take a read-only snapshot of the VDI, returning a reference to the snapshot.
Task	snapshotAsync(Connection c, java.util.Map<java.lang.String,java.lang.String> driverParams) Take a read-only snapshot of the VDI, returning a reference to the snapshot.
java.lang.String	toWireString()
void	update(Connection c) Ask the storage backend to refresh the fields in the VDI object First published in XenServer 4.1.1.
Task	updateAsync(Connection c) Ask the storage backend to refresh the fields in the VDI object First published in XenServer 4.1.1.

Methods inherited from class com.xensource.xenapi.XenAPIObject

isNull

Methods inherited from class java.lang.Object

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

Field Detail

ref

protected final java.lang.String ref

The XenAPI reference (OpaqueRef) to this object.

Method Detail

toWireString

public java.lang.String toWireString()

Specified by:

toWireString in class XenAPIObject

Returns:

The XenAPI reference (OpaqueRef) to this object.

equals

public boolean equals(java.lang.Object obj)

If obj is a VDI, compares XenAPI references for equality.

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

getRecord

public VDI.Record getRecord(Connection c)
                     throws Types.BadServerResponse,
                            Types.XenAPIException,
                            org.apache.xmlrpc.XmlRpcException

Get a record containing the current state of the given VDI. First published in XenServer 4.0.

Returns:

all fields from the object

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getByUuid

public static VDI getByUuid(Connection c,
            java.lang.String uuid)
                     throws Types.BadServerResponse,
                            Types.XenAPIException,
                            org.apache.xmlrpc.XmlRpcException

Get a reference to the VDI instance with the specified UUID. First published in XenServer 4.0.

Parameters:

uuid - UUID of object to return

Returns:

reference to the object

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

createAsync

public static Task createAsync(Connection c,
               VDI.Record record)
                        throws Types.BadServerResponse,
                               Types.XenAPIException,
                               org.apache.xmlrpc.XmlRpcException

Create a new VDI instance, and return its handle. First published in XenServer 4.0.

Parameters:

record - All constructor arguments

Returns:

Task

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

create

public static VDI create(Connection c,
         VDI.Record record)
                  throws Types.BadServerResponse,
                         Types.XenAPIException,
                         org.apache.xmlrpc.XmlRpcException

Create a new VDI instance, and return its handle. First published in XenServer 4.0.

Parameters:

record - All constructor arguments

Returns:

reference to the newly created object

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

destroyAsync

public Task destroyAsync(Connection c)
                  throws Types.BadServerResponse,
                         Types.XenAPIException,
                         org.apache.xmlrpc.XmlRpcException

Destroy the specified VDI instance. First published in XenServer 4.0.

Returns:

Task

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

destroy

public void destroy(Connection c)
             throws Types.BadServerResponse,
                    Types.XenAPIException,
                    org.apache.xmlrpc.XmlRpcException

Destroy the specified VDI instance. First published in XenServer 4.0.

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getByNameLabel

public static java.util.Set<VDI> getByNameLabel(Connection c,
                                java.lang.String label)
                                         throws Types.BadServerResponse,
                                                Types.XenAPIException,
                                                org.apache.xmlrpc.XmlRpcException

Get all the VDI instances with the given label. First published in XenServer 4.0.

Parameters:

label - label of object to return

Returns:

references to objects with matching names

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getUuid

public java.lang.String getUuid(Connection c)
                         throws Types.BadServerResponse,
                                Types.XenAPIException,
                                org.apache.xmlrpc.XmlRpcException

Get the uuid field of the given VDI. First published in XenServer 4.0.

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getNameLabel

public java.lang.String getNameLabel(Connection c)
                              throws Types.BadServerResponse,
                                     Types.XenAPIException,
                                     org.apache.xmlrpc.XmlRpcException

Get the name/label field of the given VDI. First published in XenServer 4.0.

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getNameDescription

public java.lang.String getNameDescription(Connection c)
                                    throws Types.BadServerResponse,
                                           Types.XenAPIException,
                                           org.apache.xmlrpc.XmlRpcException

Get the name/description field of the given VDI. First published in XenServer 4.0.

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getAllowedOperations

public java.util.Set<Types.VdiOperations> getAllowedOperations(Connection c)
                                                        throws Types.BadServerResponse,
                                                               Types.XenAPIException,
                                                               org.apache.xmlrpc.XmlRpcException

Get the allowed_operations field of the given VDI. First published in XenServer 4.0.

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getCurrentOperations

public java.util.Map<java.lang.String,Types.VdiOperations> getCurrentOperations(Connection c)
                                                                         throws Types.BadServerResponse,
                                                                                Types.XenAPIException,
                                                                                org.apache.xmlrpc.XmlRpcException

Get the current_operations field of the given VDI. First published in XenServer 4.0.

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getSR

public SR getSR(Connection c)
         throws Types.BadServerResponse,
                Types.XenAPIException,
                org.apache.xmlrpc.XmlRpcException

Get the SR field of the given VDI. First published in XenServer 4.0.

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getVBDs

public java.util.Set<VBD> getVBDs(Connection c)
                           throws Types.BadServerResponse,
                                  Types.XenAPIException,
                                  org.apache.xmlrpc.XmlRpcException

Get the VBDs field of the given VDI. First published in XenServer 4.0.

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getCrashDumps

public java.util.Set<Crashdump> getCrashDumps(Connection c)
                                       throws Types.BadServerResponse,
                                              Types.XenAPIException,
                                              org.apache.xmlrpc.XmlRpcException

Get the crash_dumps field of the given VDI. First published in XenServer 4.0.

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getVirtualSize

public java.lang.Long getVirtualSize(Connection c)
                              throws Types.BadServerResponse,
                                     Types.XenAPIException,
                                     org.apache.xmlrpc.XmlRpcException

Get the virtual_size field of the given VDI. First published in XenServer 4.0.

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getPhysicalUtilisation

public java.lang.Long getPhysicalUtilisation(Connection c)
                                      throws Types.BadServerResponse,
                                             Types.XenAPIException,
                                             org.apache.xmlrpc.XmlRpcException

Get the physical_utilisation field of the given VDI. First published in XenServer 4.0.

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getType

public Types.VdiType getType(Connection c)
                      throws Types.BadServerResponse,
                             Types.XenAPIException,
                             org.apache.xmlrpc.XmlRpcException

Get the type field of the given VDI. First published in XenServer 4.0.

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getSharable

public java.lang.Boolean getSharable(Connection c)
                              throws Types.BadServerResponse,
                                     Types.XenAPIException,
                                     org.apache.xmlrpc.XmlRpcException

Get the sharable field of the given VDI. First published in XenServer 4.0.

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getReadOnly

public java.lang.Boolean getReadOnly(Connection c)
                              throws Types.BadServerResponse,
                                     Types.XenAPIException,
                                     org.apache.xmlrpc.XmlRpcException

Get the read_only field of the given VDI. First published in XenServer 4.0.

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getOtherConfig

public java.util.Map<java.lang.String,java.lang.String> getOtherConfig(Connection c)
                                                                throws Types.BadServerResponse,
                                                                       Types.XenAPIException,
                                                                       org.apache.xmlrpc.XmlRpcException

Get the other_config field of the given VDI. First published in XenServer 4.0.

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getStorageLock

public java.lang.Boolean getStorageLock(Connection c)
                                 throws Types.BadServerResponse,
                                        Types.XenAPIException,
                                        org.apache.xmlrpc.XmlRpcException

Get the storage_lock field of the given VDI. First published in XenServer 4.0.

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getLocation

public java.lang.String getLocation(Connection c)
                             throws Types.BadServerResponse,
                                    Types.XenAPIException,
                                    org.apache.xmlrpc.XmlRpcException

Get the location field of the given VDI. First published in XenServer 4.1.

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getManaged

public java.lang.Boolean getManaged(Connection c)
                             throws Types.BadServerResponse,
                                    Types.XenAPIException,
                                    org.apache.xmlrpc.XmlRpcException

Get the managed field of the given VDI. First published in XenServer 4.0.

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getMissing

public java.lang.Boolean getMissing(Connection c)
                             throws Types.BadServerResponse,
                                    Types.XenAPIException,
                                    org.apache.xmlrpc.XmlRpcException

Get the missing field of the given VDI. First published in XenServer 4.0.

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getParent

@Deprecated
public VDI getParent(Connection c)
              throws Types.BadServerResponse,
                     Types.XenAPIException,
                     org.apache.xmlrpc.XmlRpcException

Deprecated.

Get the parent field of the given VDI. First published in XenServer 4.0.

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getXenstoreData

public java.util.Map<java.lang.String,java.lang.String> getXenstoreData(Connection c)
                                                                 throws Types.BadServerResponse,
                                                                        Types.XenAPIException,
                                                                        org.apache.xmlrpc.XmlRpcException

Get the xenstore_data field of the given VDI. First published in XenServer 4.1.

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getSmConfig

public java.util.Map<java.lang.String,java.lang.String> getSmConfig(Connection c)
                                                             throws Types.BadServerResponse,
                                                                    Types.XenAPIException,
                                                                    org.apache.xmlrpc.XmlRpcException

Get the sm_config field of the given VDI. First published in XenServer 4.1.

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getIsASnapshot

public java.lang.Boolean getIsASnapshot(Connection c)
                                 throws Types.BadServerResponse,
                                        Types.XenAPIException,
                                        org.apache.xmlrpc.XmlRpcException

Get the is_a_snapshot field of the given VDI. First published in XenServer 5.0.

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getSnapshotOf

public VDI getSnapshotOf(Connection c)
                  throws Types.BadServerResponse,
                         Types.XenAPIException,
                         org.apache.xmlrpc.XmlRpcException

Get the snapshot_of field of the given VDI. First published in XenServer 5.0.

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getSnapshots

public java.util.Set<VDI> getSnapshots(Connection c)
                                throws Types.BadServerResponse,
                                       Types.XenAPIException,
                                       org.apache.xmlrpc.XmlRpcException

Get the snapshots field of the given VDI. First published in XenServer 5.0.

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getSnapshotTime

public java.util.Date getSnapshotTime(Connection c)
                               throws Types.BadServerResponse,
                                      Types.XenAPIException,
                                      org.apache.xmlrpc.XmlRpcException

Get the snapshot_time field of the given VDI. First published in XenServer 5.0.

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getTags

public java.util.Set<java.lang.String> getTags(Connection c)
                                        throws Types.BadServerResponse,
                                               Types.XenAPIException,
                                               org.apache.xmlrpc.XmlRpcException

Get the tags field of the given VDI. First published in XenServer 5.0.

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getAllowCaching

public java.lang.Boolean getAllowCaching(Connection c)
                                  throws Types.BadServerResponse,
                                         Types.XenAPIException,
                                         org.apache.xmlrpc.XmlRpcException

Get the allow_caching field of the given VDI. First published in XenServer 5.6 FP1.

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getOnBoot

public Types.OnBoot getOnBoot(Connection c)
                       throws Types.BadServerResponse,
                              Types.XenAPIException,
                              org.apache.xmlrpc.XmlRpcException

Get the on_boot field of the given VDI. First published in XenServer 5.6 FP1.

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getMetadataOfPool

public Pool getMetadataOfPool(Connection c)
                       throws Types.BadServerResponse,
                              Types.XenAPIException,
                              org.apache.xmlrpc.XmlRpcException

Get the metadata_of_pool field of the given VDI. First published in XenServer 6.0.

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getMetadataLatest

public java.lang.Boolean getMetadataLatest(Connection c)
                                    throws Types.BadServerResponse,
                                           Types.XenAPIException,
                                           org.apache.xmlrpc.XmlRpcException

Get the metadata_latest field of the given VDI. First published in XenServer 6.0.

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getIsToolsIso

public java.lang.Boolean getIsToolsIso(Connection c)
                                throws Types.BadServerResponse,
                                       Types.XenAPIException,
                                       org.apache.xmlrpc.XmlRpcException

Get the is_tools_iso field of the given VDI. First published in XenServer 7.0.

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getCbtEnabled

public java.lang.Boolean getCbtEnabled(Connection c)
                                throws Types.BadServerResponse,
                                       Types.XenAPIException,
                                       org.apache.xmlrpc.XmlRpcException

Get the cbt_enabled field of the given VDI. First published in XenServer 7.3.

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

setOtherConfig

public void setOtherConfig(Connection c,
                  java.util.Map<java.lang.String,java.lang.String> otherConfig)
                    throws Types.BadServerResponse,
                           Types.XenAPIException,
                           org.apache.xmlrpc.XmlRpcException

Set the other_config field of the given VDI. First published in XenServer 4.0.

Parameters:

otherConfig - New value to set

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

addToOtherConfig

public void addToOtherConfig(Connection c,
                    java.lang.String key,
                    java.lang.String value)
                      throws Types.BadServerResponse,
                             Types.XenAPIException,
                             org.apache.xmlrpc.XmlRpcException

Add the given key-value pair to the other_config field of the given VDI. First published in XenServer 4.0.

Parameters:

key - Key to add

value - Value to add

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

removeFromOtherConfig

public void removeFromOtherConfig(Connection c,
                         java.lang.String key)
                           throws Types.BadServerResponse,
                                  Types.XenAPIException,
                                  org.apache.xmlrpc.XmlRpcException

Remove the given key and its corresponding value from the other_config field of the given VDI. If the key is not in that Map, then do nothing. First published in XenServer 4.0.

Parameters:

key - Key to remove

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

setXenstoreData

public void setXenstoreData(Connection c,
                   java.util.Map<java.lang.String,java.lang.String> xenstoreData)
                     throws Types.BadServerResponse,
                            Types.XenAPIException,
                            org.apache.xmlrpc.XmlRpcException

Set the xenstore_data field of the given VDI. First published in XenServer 4.1.

Parameters:

xenstoreData - New value to set

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

addToXenstoreData

public void addToXenstoreData(Connection c,
                     java.lang.String key,
                     java.lang.String value)
                       throws Types.BadServerResponse,
                              Types.XenAPIException,
                              org.apache.xmlrpc.XmlRpcException

Add the given key-value pair to the xenstore_data field of the given VDI. First published in XenServer 4.1.

Parameters:

key - Key to add

value - Value to add

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

removeFromXenstoreData

public void removeFromXenstoreData(Connection c,
                          java.lang.String key)
                            throws Types.BadServerResponse,
                                   Types.XenAPIException,
                                   org.apache.xmlrpc.XmlRpcException

Remove the given key and its corresponding value from the xenstore_data field of the given VDI. If the key is not in that Map, then do nothing. First published in XenServer 4.1.

Parameters:

key - Key to remove

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

setSmConfig

public void setSmConfig(Connection c,
               java.util.Map<java.lang.String,java.lang.String> smConfig)
                 throws Types.BadServerResponse,
                        Types.XenAPIException,
                        org.apache.xmlrpc.XmlRpcException

Set the sm_config field of the given VDI. First published in XenServer 4.1.

Parameters:

smConfig - New value to set

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

addToSmConfig

public void addToSmConfig(Connection c,
                 java.lang.String key,
                 java.lang.String value)
                   throws Types.BadServerResponse,
                          Types.XenAPIException,
                          org.apache.xmlrpc.XmlRpcException

Add the given key-value pair to the sm_config field of the given VDI. First published in XenServer 4.1.

Parameters:

key - Key to add

value - Value to add

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

removeFromSmConfig

public void removeFromSmConfig(Connection c,
                      java.lang.String key)
                        throws Types.BadServerResponse,
                               Types.XenAPIException,
                               org.apache.xmlrpc.XmlRpcException

Remove the given key and its corresponding value from the sm_config field of the given VDI. If the key is not in that Map, then do nothing. First published in XenServer 4.1.

Parameters:

key - Key to remove

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

setTags

public void setTags(Connection c,
           java.util.Set<java.lang.String> tags)
             throws Types.BadServerResponse,
                    Types.XenAPIException,
                    org.apache.xmlrpc.XmlRpcException

Set the tags field of the given VDI. First published in XenServer 5.0.

Parameters:

tags - New value to set

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

addTags

public void addTags(Connection c,
           java.lang.String value)
             throws Types.BadServerResponse,
                    Types.XenAPIException,
                    org.apache.xmlrpc.XmlRpcException

Add the given value to the tags field of the given VDI. If the value is already in that Set, then do nothing. First published in XenServer 5.0.

Parameters:

value - New value to add

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

removeTags

public void removeTags(Connection c,
              java.lang.String value)
                throws Types.BadServerResponse,
                       Types.XenAPIException,
                       org.apache.xmlrpc.XmlRpcException

Remove the given value from the tags field of the given VDI. If the value is not in that Set, then do nothing. First published in XenServer 5.0.

Parameters:

value - Value to remove

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

snapshotAsync

public Task snapshotAsync(Connection c,
                 java.util.Map<java.lang.String,java.lang.String> driverParams)
                   throws Types.BadServerResponse,
                          Types.XenAPIException,
                          org.apache.xmlrpc.XmlRpcException

Take a read-only snapshot of the VDI, returning a reference to the snapshot. If any driver_params are specified then these are passed through to the storage-specific substrate driver that takes the snapshot. NB the snapshot lives in the same Storage Repository as its parent. First published in XenServer 4.0.

Parameters:

driverParams - Optional parameters that can be passed through to backend driver in order to specify storage-type-specific snapshot options First published in XenServer 4.1.

Returns:

Task

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

snapshot

public VDI snapshot(Connection c,
           java.util.Map<java.lang.String,java.lang.String> driverParams)
             throws Types.BadServerResponse,
                    Types.XenAPIException,
                    org.apache.xmlrpc.XmlRpcException

Take a read-only snapshot of the VDI, returning a reference to the snapshot. If any driver_params are specified then these are passed through to the storage-specific substrate driver that takes the snapshot. NB the snapshot lives in the same Storage Repository as its parent. First published in XenServer 4.0.

Parameters:

driverParams - Optional parameters that can be passed through to backend driver in order to specify storage-type-specific snapshot options First published in XenServer 4.1.

Returns:

The ID of the newly created VDI.

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

createCloneAsync

public Task createCloneAsync(Connection c,
                    java.util.Map<java.lang.String,java.lang.String> driverParams)
                      throws Types.BadServerResponse,
                             Types.XenAPIException,
                             org.apache.xmlrpc.XmlRpcException

Take an exact copy of the VDI and return a reference to the new disk. If any driver_params are specified then these are passed through to the storage-specific substrate driver that implements the clone operation. NB the clone lives in the same Storage Repository as its parent. First published in XenServer 4.0.

Parameters:

driverParams - Optional parameters that are passed through to the backend driver in order to specify storage-type-specific clone options First published in XenServer 4.1.

Returns:

Task

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

createClone

public VDI createClone(Connection c,
              java.util.Map<java.lang.String,java.lang.String> driverParams)
                throws Types.BadServerResponse,
                       Types.XenAPIException,
                       org.apache.xmlrpc.XmlRpcException

Take an exact copy of the VDI and return a reference to the new disk. If any driver_params are specified then these are passed through to the storage-specific substrate driver that implements the clone operation. NB the clone lives in the same Storage Repository as its parent. First published in XenServer 4.0.

Parameters:

driverParams - Optional parameters that are passed through to the backend driver in order to specify storage-type-specific clone options First published in XenServer 4.1.

Returns:

The ID of the newly created VDI.

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

resizeAsync

public Task resizeAsync(Connection c,
               java.lang.Long size)
                 throws Types.BadServerResponse,
                        Types.XenAPIException,
                        org.apache.xmlrpc.XmlRpcException

Resize the VDI. First published in XenServer 4.0.

Parameters:

size - The new size of the VDI

Returns:

Task

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

resize

public void resize(Connection c,
          java.lang.Long size)
            throws Types.BadServerResponse,
                   Types.XenAPIException,
                   org.apache.xmlrpc.XmlRpcException

Resize the VDI. First published in XenServer 4.0.

Parameters:

size - The new size of the VDI

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

resizeOnlineAsync

public Task resizeOnlineAsync(Connection c,
                     java.lang.Long size)
                       throws Types.BadServerResponse,
                              Types.XenAPIException,
                              org.apache.xmlrpc.XmlRpcException

Resize the VDI which may or may not be attached to running guests. First published in XenServer 4.0.

Parameters:

size - The new size of the VDI

Returns:

Task

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

resizeOnline

public void resizeOnline(Connection c,
                java.lang.Long size)
                  throws Types.BadServerResponse,
                         Types.XenAPIException,
                         org.apache.xmlrpc.XmlRpcException

Resize the VDI which may or may not be attached to running guests. First published in XenServer 4.0.

Parameters:

size - The new size of the VDI

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

introduceAsync

public static Task introduceAsync(Connection c,
                  java.lang.String uuid,
                  java.lang.String nameLabel,
                  java.lang.String nameDescription,
                  SR SR,
                  Types.VdiType type,
                  java.lang.Boolean sharable,
                  java.lang.Boolean readOnly,
                  java.util.Map<java.lang.String,java.lang.String> otherConfig,
                  java.lang.String location,
                  java.util.Map<java.lang.String,java.lang.String> xenstoreData,
                  java.util.Map<java.lang.String,java.lang.String> smConfig)
                           throws Types.BadServerResponse,
                                  Types.XenAPIException,
                                  org.apache.xmlrpc.XmlRpcException,
                                  Types.SrOperationNotSupported

Create a new VDI record in the database only First published in XenServer 4.1.

Parameters:

uuid - The uuid of the disk to introduce

nameLabel - The name of the disk record

nameDescription - The description of the disk record

SR - The SR that the VDI is in

type - The type of the VDI

sharable - true if this disk may be shared

readOnly - true if this disk may ONLY be mounted read-only

otherConfig - additional configuration

location - location information

xenstoreData - Data to insert into xenstore

smConfig - Storage-specific config

Returns:

Task

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

Types.SrOperationNotSupported

introduce

public static VDI introduce(Connection c,
            java.lang.String uuid,
            java.lang.String nameLabel,
            java.lang.String nameDescription,
            SR SR,
            Types.VdiType type,
            java.lang.Boolean sharable,
            java.lang.Boolean readOnly,
            java.util.Map<java.lang.String,java.lang.String> otherConfig,
            java.lang.String location,
            java.util.Map<java.lang.String,java.lang.String> xenstoreData,
            java.util.Map<java.lang.String,java.lang.String> smConfig)
                     throws Types.BadServerResponse,
                            Types.XenAPIException,
                            org.apache.xmlrpc.XmlRpcException,
                            Types.SrOperationNotSupported

Create a new VDI record in the database only First published in XenServer 4.1.

Parameters:

uuid - The uuid of the disk to introduce

nameLabel - The name of the disk record

nameDescription - The description of the disk record

SR - The SR that the VDI is in

type - The type of the VDI

sharable - true if this disk may be shared

readOnly - true if this disk may ONLY be mounted read-only

otherConfig - additional configuration

location - location information

xenstoreData - Data to insert into xenstore

smConfig - Storage-specific config

Returns:

The ref of the newly created VDI record.

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

Types.SrOperationNotSupported

introduceAsync

public static Task introduceAsync(Connection c,
                  java.lang.String uuid,
                  java.lang.String nameLabel,
                  java.lang.String nameDescription,
                  SR SR,
                  Types.VdiType type,
                  java.lang.Boolean sharable,
                  java.lang.Boolean readOnly,
                  java.util.Map<java.lang.String,java.lang.String> otherConfig,
                  java.lang.String location,
                  java.util.Map<java.lang.String,java.lang.String> xenstoreData,
                  java.util.Map<java.lang.String,java.lang.String> smConfig,
                  java.lang.Boolean managed,
                  java.lang.Long virtualSize,
                  java.lang.Long physicalUtilisation,
                  Pool metadataOfPool,
                  java.lang.Boolean isASnapshot,
                  java.util.Date snapshotTime,
                  VDI snapshotOf)
                           throws Types.BadServerResponse,
                                  Types.XenAPIException,
                                  org.apache.xmlrpc.XmlRpcException,
                                  Types.SrOperationNotSupported

Create a new VDI record in the database only First published in XenServer 4.1.

Parameters:

uuid - The uuid of the disk to introduce

nameLabel - The name of the disk record

nameDescription - The description of the disk record

SR - The SR that the VDI is in

type - The type of the VDI

sharable - true if this disk may be shared

readOnly - true if this disk may ONLY be mounted read-only

otherConfig - additional configuration

location - location information

xenstoreData - Data to insert into xenstore

smConfig - Storage-specific config

managed - Storage-specific config First published in XenServer 6.1.

virtualSize - Storage-specific config First published in XenServer 6.1.

physicalUtilisation - Storage-specific config First published in XenServer 6.1.

metadataOfPool - Storage-specific config First published in XenServer 6.1.

isASnapshot - Storage-specific config First published in XenServer 6.1.

snapshotTime - Storage-specific config First published in XenServer 6.1.

snapshotOf - Storage-specific config First published in XenServer 6.1.

Returns:

Task

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

Types.SrOperationNotSupported

introduce

public static VDI introduce(Connection c,
            java.lang.String uuid,
            java.lang.String nameLabel,
            java.lang.String nameDescription,
            SR SR,
            Types.VdiType type,
            java.lang.Boolean sharable,
            java.lang.Boolean readOnly,
            java.util.Map<java.lang.String,java.lang.String> otherConfig,
            java.lang.String location,
            java.util.Map<java.lang.String,java.lang.String> xenstoreData,
            java.util.Map<java.lang.String,java.lang.String> smConfig,
            java.lang.Boolean managed,
            java.lang.Long virtualSize,
            java.lang.Long physicalUtilisation,
            Pool metadataOfPool,
            java.lang.Boolean isASnapshot,
            java.util.Date snapshotTime,
            VDI snapshotOf)
                     throws Types.BadServerResponse,
                            Types.XenAPIException,
                            org.apache.xmlrpc.XmlRpcException,
                            Types.SrOperationNotSupported

Create a new VDI record in the database only First published in XenServer 4.1.

Parameters:

uuid - The uuid of the disk to introduce

nameLabel - The name of the disk record

nameDescription - The description of the disk record

SR - The SR that the VDI is in

type - The type of the VDI

sharable - true if this disk may be shared

readOnly - true if this disk may ONLY be mounted read-only

otherConfig - additional configuration

location - location information

xenstoreData - Data to insert into xenstore

smConfig - Storage-specific config

managed - Storage-specific config First published in XenServer 6.1.

virtualSize - Storage-specific config First published in XenServer 6.1.

physicalUtilisation - Storage-specific config First published in XenServer 6.1.

metadataOfPool - Storage-specific config First published in XenServer 6.1.

isASnapshot - Storage-specific config First published in XenServer 6.1.

snapshotTime - Storage-specific config First published in XenServer 6.1.

snapshotOf - Storage-specific config First published in XenServer 6.1.

Returns:

The ref of the newly created VDI record.

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

Types.SrOperationNotSupported

updateAsync

public Task updateAsync(Connection c)
                 throws Types.BadServerResponse,
                        Types.XenAPIException,
                        org.apache.xmlrpc.XmlRpcException,
                        Types.SrOperationNotSupported

Ask the storage backend to refresh the fields in the VDI object First published in XenServer 4.1.1.

Returns:

Task

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

Types.SrOperationNotSupported

update

public void update(Connection c)
            throws Types.BadServerResponse,
                   Types.XenAPIException,
                   org.apache.xmlrpc.XmlRpcException,
                   Types.SrOperationNotSupported

Ask the storage backend to refresh the fields in the VDI object First published in XenServer 4.1.1.

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

Types.SrOperationNotSupported

copyAsync

public Task copyAsync(Connection c,
             SR sr)
               throws Types.BadServerResponse,
                      Types.XenAPIException,
                      org.apache.xmlrpc.XmlRpcException,
                      Types.VdiReadonly,
                      Types.VdiTooSmall,
                      Types.VdiNotSparse

Copy either a full VDI or the block differences between two VDIs into either a fresh VDI or an existing VDI. First published in XenServer 4.0.

Parameters:

sr - The destination SR (only required if the destination VDI is not specified

Returns:

Task

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

Types.VdiReadonly

Types.VdiTooSmall

Types.VdiNotSparse

copy

public VDI copy(Connection c,
       SR sr)
         throws Types.BadServerResponse,
                Types.XenAPIException,
                org.apache.xmlrpc.XmlRpcException,
                Types.VdiReadonly,
                Types.VdiTooSmall,
                Types.VdiNotSparse

Copy either a full VDI or the block differences between two VDIs into either a fresh VDI or an existing VDI. First published in XenServer 4.0.

Parameters:

sr - The destination SR (only required if the destination VDI is not specified

Returns:

The reference of the VDI where the blocks were written.

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

Types.VdiReadonly

Types.VdiTooSmall

Types.VdiNotSparse

copyAsync

public Task copyAsync(Connection c,
             SR sr,
             VDI baseVdi,
             VDI intoVdi)
               throws Types.BadServerResponse,
                      Types.XenAPIException,
                      org.apache.xmlrpc.XmlRpcException,
                      Types.VdiReadonly,
                      Types.VdiTooSmall,
                      Types.VdiNotSparse

Copy either a full VDI or the block differences between two VDIs into either a fresh VDI or an existing VDI. First published in XenServer 4.0.

Parameters:

sr - The destination SR (only required if the destination VDI is not specified

baseVdi - The base VDI (only required if copying only changed blocks, by default all blocks will be copied) First published in XenServer 6.2 SP1 Hotfix 4.

intoVdi - The destination VDI to copy blocks into (if omitted then a destination SR must be provided and a fresh VDI will be created) First published in XenServer 6.2 SP1 Hotfix 4.

Returns:

Task

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

Types.VdiReadonly

Types.VdiTooSmall

Types.VdiNotSparse

copy

public VDI copy(Connection c,
       SR sr,
       VDI baseVdi,
       VDI intoVdi)
         throws Types.BadServerResponse,
                Types.XenAPIException,
                org.apache.xmlrpc.XmlRpcException,
                Types.VdiReadonly,
                Types.VdiTooSmall,
                Types.VdiNotSparse

Copy either a full VDI or the block differences between two VDIs into either a fresh VDI or an existing VDI. First published in XenServer 4.0.

Parameters:

sr - The destination SR (only required if the destination VDI is not specified

baseVdi - The base VDI (only required if copying only changed blocks, by default all blocks will be copied) First published in XenServer 6.2 SP1 Hotfix 4.

intoVdi - The destination VDI to copy blocks into (if omitted then a destination SR must be provided and a fresh VDI will be created) First published in XenServer 6.2 SP1 Hotfix 4.

Returns:

The reference of the VDI where the blocks were written.

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

Types.VdiReadonly

Types.VdiTooSmall

Types.VdiNotSparse

forgetAsync

public Task forgetAsync(Connection c)
                 throws Types.BadServerResponse,
                        Types.XenAPIException,
                        org.apache.xmlrpc.XmlRpcException

Removes a VDI record from the database First published in XenServer 4.0.

Returns:

Task

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

forget

public void forget(Connection c)
            throws Types.BadServerResponse,
                   Types.XenAPIException,
                   org.apache.xmlrpc.XmlRpcException

Removes a VDI record from the database First published in XenServer 4.0.

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

setSharable

public void setSharable(Connection c,
               java.lang.Boolean value)
                 throws Types.BadServerResponse,
                        Types.XenAPIException,
                        org.apache.xmlrpc.XmlRpcException

Sets the VDI's sharable field First published in XenServer 5.5.

Parameters:

value - The new value of the VDI's sharable field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

setReadOnly

public void setReadOnly(Connection c,
               java.lang.Boolean value)
                 throws Types.BadServerResponse,
                        Types.XenAPIException,
                        org.apache.xmlrpc.XmlRpcException

Sets the VDI's read_only field First published in XenServer 4.0.

Parameters:

value - The new value of the VDI's read_only field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

setNameLabelAsync

public Task setNameLabelAsync(Connection c,
                     java.lang.String value)
                       throws Types.BadServerResponse,
                              Types.XenAPIException,
                              org.apache.xmlrpc.XmlRpcException

Set the name label of the VDI. This can only happen when then its SR is currently attached. First published in XenServer 4.0.

Parameters:

value - The name lable for the VDI

Returns:

Task

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

setNameLabel

public void setNameLabel(Connection c,
                java.lang.String value)
                  throws Types.BadServerResponse,
                         Types.XenAPIException,
                         org.apache.xmlrpc.XmlRpcException

Set the name label of the VDI. This can only happen when then its SR is currently attached. First published in XenServer 4.0.

Parameters:

value - The name lable for the VDI

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

setNameDescriptionAsync

public Task setNameDescriptionAsync(Connection c,
                           java.lang.String value)
                             throws Types.BadServerResponse,
                                    Types.XenAPIException,
                                    org.apache.xmlrpc.XmlRpcException

Set the name description of the VDI. This can only happen when its SR is currently attached. First published in XenServer 4.0.

Parameters:

value - The name description for the VDI

Returns:

Task

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

setNameDescription

public void setNameDescription(Connection c,
                      java.lang.String value)
                        throws Types.BadServerResponse,
                               Types.XenAPIException,
                               org.apache.xmlrpc.XmlRpcException

Set the name description of the VDI. This can only happen when its SR is currently attached. First published in XenServer 4.0.

Parameters:

value - The name description for the VDI

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

setOnBootAsync

public Task setOnBootAsync(Connection c,
                  Types.OnBoot value)
                    throws Types.BadServerResponse,
                           Types.XenAPIException,
                           org.apache.xmlrpc.XmlRpcException

Set the value of the on_boot parameter. This value can only be changed when the VDI is not attached to a running VM. First published in XenServer 5.6 FP1.

Parameters:

value - The value to set

Returns:

Task

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

setOnBoot

public void setOnBoot(Connection c,
             Types.OnBoot value)
               throws Types.BadServerResponse,
                      Types.XenAPIException,
                      org.apache.xmlrpc.XmlRpcException

Set the value of the on_boot parameter. This value can only be changed when the VDI is not attached to a running VM. First published in XenServer 5.6 FP1.

Parameters:

value - The value to set

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

setAllowCachingAsync

public Task setAllowCachingAsync(Connection c,
                        java.lang.Boolean value)
                          throws Types.BadServerResponse,
                                 Types.XenAPIException,
                                 org.apache.xmlrpc.XmlRpcException

Set the value of the allow_caching parameter. This value can only be changed when the VDI is not attached to a running VM. The caching behaviour is only affected by this flag for VHD-based VDIs that have one parent and no child VHDs. Moreover, caching only takes place when the host running the VM containing this VDI has a nominated SR for local caching. First published in XenServer 5.6 FP1.

Parameters:

value - The value to set

Returns:

Task

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

setAllowCaching

public void setAllowCaching(Connection c,
                   java.lang.Boolean value)
                     throws Types.BadServerResponse,
                            Types.XenAPIException,
                            org.apache.xmlrpc.XmlRpcException

Set the value of the allow_caching parameter. This value can only be changed when the VDI is not attached to a running VM. The caching behaviour is only affected by this flag for VHD-based VDIs that have one parent and no child VHDs. Moreover, caching only takes place when the host running the VM containing this VDI has a nominated SR for local caching. First published in XenServer 5.6 FP1.

Parameters:

value - The value to set

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

openDatabaseAsync

public Task openDatabaseAsync(Connection c)
                       throws Types.BadServerResponse,
                              Types.XenAPIException,
                              org.apache.xmlrpc.XmlRpcException

Load the metadata found on the supplied VDI and return a session reference which can be used in API calls to query its contents. First published in XenServer 6.0.

Returns:

Task

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

openDatabase

public Session openDatabase(Connection c)
                     throws Types.BadServerResponse,
                            Types.XenAPIException,
                            org.apache.xmlrpc.XmlRpcException

Load the metadata found on the supplied VDI and return a session reference which can be used in API calls to query its contents. First published in XenServer 6.0.

Returns:

A session which can be used to query the database

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

readDatabasePoolUuidAsync

public Task readDatabasePoolUuidAsync(Connection c)
                               throws Types.BadServerResponse,
                                      Types.XenAPIException,
                                      org.apache.xmlrpc.XmlRpcException

Check the VDI cache for the pool UUID of the database on this VDI. First published in XenServer 6.0.

Returns:

Task

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

readDatabasePoolUuid

public java.lang.String readDatabasePoolUuid(Connection c)
                                      throws Types.BadServerResponse,
                                             Types.XenAPIException,
                                             org.apache.xmlrpc.XmlRpcException

Check the VDI cache for the pool UUID of the database on this VDI. First published in XenServer 6.0.

Returns:

The cached pool UUID of the database on the VDI.

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

poolMigrateAsync

public Task poolMigrateAsync(Connection c,
                    SR sr,
                    java.util.Map<java.lang.String,java.lang.String> options)
                      throws Types.BadServerResponse,
                             Types.XenAPIException,
                             org.apache.xmlrpc.XmlRpcException

Migrate a VDI, which may be attached to a running guest, to a different SR. The destination SR must be visible to the guest. First published in XenServer 6.1.

Parameters:

sr - The destination SR

options - Other parameters

Returns:

Task

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

poolMigrate

public VDI poolMigrate(Connection c,
              SR sr,
              java.util.Map<java.lang.String,java.lang.String> options)
                throws Types.BadServerResponse,
                       Types.XenAPIException,
                       org.apache.xmlrpc.XmlRpcException

Migrate a VDI, which may be attached to a running guest, to a different SR. The destination SR must be visible to the guest. First published in XenServer 6.1.

Parameters:

sr - The destination SR

options - Other parameters

Returns:

The new reference of the migrated VDI.

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

enableCbtAsync

public Task enableCbtAsync(Connection c)
                    throws Types.BadServerResponse,
                           Types.XenAPIException,
                           org.apache.xmlrpc.XmlRpcException,
                           Types.SrOperationNotSupported,
                           Types.VdiMissing,
                           Types.SrNotAttached,
                           Types.SrHasNoPbds,
                           Types.OperationNotAllowed,
                           Types.VdiIncompatibleType,
                           Types.VdiOnBootModeIncompatibleWithOperation

Enable changed block tracking for the VDI. This call is idempotent - enabling CBT for a VDI for which CBT is already enabled results in a no-op, and no error will be thrown. First published in XenServer 7.3.

Returns:

Task

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

Types.SrOperationNotSupported

Types.VdiMissing

Types.SrNotAttached

Types.SrHasNoPbds

Types.OperationNotAllowed

Types.VdiIncompatibleType

Types.VdiOnBootModeIncompatibleWithOperation

enableCbt

public void enableCbt(Connection c)
               throws Types.BadServerResponse,
                      Types.XenAPIException,
                      org.apache.xmlrpc.XmlRpcException,
                      Types.SrOperationNotSupported,
                      Types.VdiMissing,
                      Types.SrNotAttached,
                      Types.SrHasNoPbds,
                      Types.OperationNotAllowed,
                      Types.VdiIncompatibleType,
                      Types.VdiOnBootModeIncompatibleWithOperation

Enable changed block tracking for the VDI. This call is idempotent - enabling CBT for a VDI for which CBT is already enabled results in a no-op, and no error will be thrown. First published in XenServer 7.3.

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

Types.SrOperationNotSupported

Types.VdiMissing

Types.SrNotAttached

Types.SrHasNoPbds

Types.OperationNotAllowed

Types.VdiIncompatibleType

Types.VdiOnBootModeIncompatibleWithOperation

disableCbtAsync

public Task disableCbtAsync(Connection c)
                     throws Types.BadServerResponse,
                            Types.XenAPIException,
                            org.apache.xmlrpc.XmlRpcException,
                            Types.SrOperationNotSupported,
                            Types.VdiMissing,
                            Types.SrNotAttached,
                            Types.SrHasNoPbds,
                            Types.OperationNotAllowed,
                            Types.VdiIncompatibleType,
                            Types.VdiOnBootModeIncompatibleWithOperation

Disable changed block tracking for the VDI. This call is only allowed on VDIs that support enabling CBT. It is an idempotent operation - disabling CBT for a VDI for which CBT is not enabled results in a no-op, and no error will be thrown. First published in XenServer 7.3.

Returns:

Task

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

Types.SrOperationNotSupported

Types.VdiMissing

Types.SrNotAttached

Types.SrHasNoPbds

Types.OperationNotAllowed

Types.VdiIncompatibleType

Types.VdiOnBootModeIncompatibleWithOperation

disableCbt

public void disableCbt(Connection c)
                throws Types.BadServerResponse,
                       Types.XenAPIException,
                       org.apache.xmlrpc.XmlRpcException,
                       Types.SrOperationNotSupported,
                       Types.VdiMissing,
                       Types.SrNotAttached,
                       Types.SrHasNoPbds,
                       Types.OperationNotAllowed,
                       Types.VdiIncompatibleType,
                       Types.VdiOnBootModeIncompatibleWithOperation

Disable changed block tracking for the VDI. This call is only allowed on VDIs that support enabling CBT. It is an idempotent operation - disabling CBT for a VDI for which CBT is not enabled results in a no-op, and no error will be thrown. First published in XenServer 7.3.

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

Types.SrOperationNotSupported

Types.VdiMissing

Types.SrNotAttached

Types.SrHasNoPbds

Types.OperationNotAllowed

Types.VdiIncompatibleType

Types.VdiOnBootModeIncompatibleWithOperation

dataDestroyAsync

public Task dataDestroyAsync(Connection c)
                      throws Types.BadServerResponse,
                             Types.XenAPIException,
                             org.apache.xmlrpc.XmlRpcException,
                             Types.SrOperationNotSupported,
                             Types.VdiMissing,
                             Types.SrNotAttached,
                             Types.SrHasNoPbds,
                             Types.OperationNotAllowed,
                             Types.VdiIncompatibleType,
                             Types.VdiNoCbtMetadata,
                             Types.VdiInUse,
                             Types.VdiIsAPhysicalDevice

Delete the data of the snapshot VDI, but keep its changed block tracking metadata. When successful, this call changes the type of the VDI to cbt_metadata. This operation is idempotent: calling it on a VDI of type cbt_metadata results in a no-op, and no error will be thrown. First published in XenServer 7.3.

Returns:

Task

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

Types.SrOperationNotSupported

Types.VdiMissing

Types.SrNotAttached

Types.SrHasNoPbds

Types.OperationNotAllowed

Types.VdiIncompatibleType

Types.VdiNoCbtMetadata

Types.VdiInUse

Types.VdiIsAPhysicalDevice

dataDestroy

public void dataDestroy(Connection c)
                 throws Types.BadServerResponse,
                        Types.XenAPIException,
                        org.apache.xmlrpc.XmlRpcException,
                        Types.SrOperationNotSupported,
                        Types.VdiMissing,
                        Types.SrNotAttached,
                        Types.SrHasNoPbds,
                        Types.OperationNotAllowed,
                        Types.VdiIncompatibleType,
                        Types.VdiNoCbtMetadata,
                        Types.VdiInUse,
                        Types.VdiIsAPhysicalDevice

Delete the data of the snapshot VDI, but keep its changed block tracking metadata. When successful, this call changes the type of the VDI to cbt_metadata. This operation is idempotent: calling it on a VDI of type cbt_metadata results in a no-op, and no error will be thrown. First published in XenServer 7.3.

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

Types.SrOperationNotSupported

Types.VdiMissing

Types.SrNotAttached

Types.SrHasNoPbds

Types.OperationNotAllowed

Types.VdiIncompatibleType

Types.VdiNoCbtMetadata

Types.VdiInUse

Types.VdiIsAPhysicalDevice

listChangedBlocksAsync

public Task listChangedBlocksAsync(Connection c,
                          VDI vdiTo)
                            throws Types.BadServerResponse,
                                   Types.XenAPIException,
                                   org.apache.xmlrpc.XmlRpcException,
                                   Types.SrOperationNotSupported,
                                   Types.VdiMissing,
                                   Types.SrNotAttached,
                                   Types.SrHasNoPbds,
                                   Types.VdiInUse

Compare two VDIs in 64k block increments and report which blocks differ. This operation is not allowed when vdi_to is attached to a VM. First published in XenServer 7.3.

Parameters:

vdiTo - The second VDI.

Returns:

Task

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

Types.SrOperationNotSupported

Types.VdiMissing

Types.SrNotAttached

Types.SrHasNoPbds

Types.VdiInUse

listChangedBlocks

public java.lang.String listChangedBlocks(Connection c,
                                 VDI vdiTo)
                                   throws Types.BadServerResponse,
                                          Types.XenAPIException,
                                          org.apache.xmlrpc.XmlRpcException,
                                          Types.SrOperationNotSupported,
                                          Types.VdiMissing,
                                          Types.SrNotAttached,
                                          Types.SrHasNoPbds,
                                          Types.VdiInUse

Compare two VDIs in 64k block increments and report which blocks differ. This operation is not allowed when vdi_to is attached to a VM. First published in XenServer 7.3.

Parameters:

vdiTo - The second VDI.

Returns:

A base64 string-encoding of the bitmap showing which blocks differ in the two VDIs.

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

Types.SrOperationNotSupported

Types.VdiMissing

Types.SrNotAttached

Types.SrHasNoPbds

Types.VdiInUse

getNbdInfo

public java.util.Set<VdiNbdServerInfo.Record> getNbdInfo(Connection c)
                                                  throws Types.BadServerResponse,
                                                         Types.XenAPIException,
                                                         org.apache.xmlrpc.XmlRpcException,
                                                         Types.VdiIncompatibleType

Get details specifying how to access this VDI via a Network Block Device server. For each of a set of NBD server addresses on which the VDI is available, the return value set contains a vdi_nbd_server_info object that contains an exportname to request once the NBD connection is established, and connection details for the address. An empty list is returned if there is no network that has a PIF on a host with access to the relevant SR, or if no such network has been assigned an NBD-related purpose in its purpose field. To access the given VDI, any of the vdi_nbd_server_info objects can be used to make a connection to a server, and then the VDI will be available by requesting the exportname. First published in XenServer 7.3.

Returns:

The details necessary for connecting to the VDI over NBD. This includes an authentication token, so must be treated as sensitive material and must not be sent over insecure networks.

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

Types.VdiIncompatibleType

getAll

public static java.util.Set<VDI> getAll(Connection c)
                                 throws Types.BadServerResponse,
                                        Types.XenAPIException,
                                        org.apache.xmlrpc.XmlRpcException

Return a list of all the VDIs known to the system. First published in XenServer 4.0.

Returns:

references to all objects

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getAllRecords

public static java.util.Map<VDI,VDI.Record> getAllRecords(Connection c)
                                                   throws Types.BadServerResponse,
                                                          Types.XenAPIException,
                                                          org.apache.xmlrpc.XmlRpcException

Return a map of VDI references to VDI records for all VDIs known to the system. First published in XenServer 4.0.

Returns:

records of all objects

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException