public class VDI extends XenAPIObject
Modifier and Type | Class and Description |
---|---|
static class |
VDI.Record
Represents all the fields in a VDI
|
Modifier and Type | Field and Description |
---|---|
protected java.lang.String |
ref
The XenAPI reference (OpaqueRef) to this object.
|
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.
|
isNull
protected final java.lang.String ref
public java.lang.String toWireString()
toWireString
in class XenAPIObject
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public VDI.Record getRecord(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
c
- The connection the call is made onTypes.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.public static VDI getByUuid(Connection c, java.lang.String uuid) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
c
- The connection the call is made onuuid
- UUID of object to returnTypes.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.public static Task createAsync(Connection c, VDI.Record record) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
c
- The connection the call is made onrecord
- All constructor argumentsTypes.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.public static VDI create(Connection c, VDI.Record record) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
c
- The connection the call is made onrecord
- All constructor argumentsTypes.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.public Task destroyAsync(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
c
- The connection the call is made onTypes.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.public void destroy(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
c
- The connection the call is made onTypes.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.public static java.util.Set<VDI> getByNameLabel(Connection c, java.lang.String label) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
c
- The connection the call is made onlabel
- label of object to returnTypes.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.public java.lang.String getUuid(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
c
- The connection the call is made onTypes.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.public java.lang.String getNameLabel(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
c
- The connection the call is made onTypes.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.public java.lang.String getNameDescription(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
c
- The connection the call is made onTypes.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.public java.util.Set<Types.VdiOperations> getAllowedOperations(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
c
- The connection the call is made onTypes.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.public java.util.Map<java.lang.String,Types.VdiOperations> getCurrentOperations(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
c
- The connection the call is made onTypes.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.public SR getSR(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
c
- The connection the call is made onTypes.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.public java.util.Set<VBD> getVBDs(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
c
- The connection the call is made onTypes.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.public java.util.Set<Crashdump> getCrashDumps(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
c
- The connection the call is made onTypes.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.public java.lang.Long getVirtualSize(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
c
- The connection the call is made onTypes.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.public java.lang.Long getPhysicalUtilisation(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
c
- The connection the call is made onTypes.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.public Types.VdiType getType(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
c
- The connection the call is made onTypes.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.public java.lang.Boolean getSharable(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
c
- The connection the call is made onTypes.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.public java.lang.Boolean getReadOnly(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
c
- The connection the call is made onTypes.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.public java.util.Map<java.lang.String,java.lang.String> getOtherConfig(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
c
- The connection the call is made onTypes.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.public java.lang.Boolean getStorageLock(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
c
- The connection the call is made onTypes.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.public java.lang.String getLocation(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
c
- The connection the call is made onTypes.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.public java.lang.Boolean getManaged(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
c
- The connection the call is made onTypes.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.public java.lang.Boolean getMissing(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
c
- The connection the call is made onTypes.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.@Deprecated public VDI getParent(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
c
- The connection the call is made onTypes.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.public java.util.Map<java.lang.String,java.lang.String> getXenstoreData(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
c
- The connection the call is made onTypes.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.public java.util.Map<java.lang.String,java.lang.String> getSmConfig(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
c
- The connection the call is made onTypes.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.public java.lang.Boolean getIsASnapshot(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
c
- The connection the call is made onTypes.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.public VDI getSnapshotOf(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
c
- The connection the call is made onTypes.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.public java.util.Set<VDI> getSnapshots(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
c
- The connection the call is made onTypes.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.public java.util.Date getSnapshotTime(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
c
- The connection the call is made onTypes.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.public java.util.Set<java.lang.String> getTags(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
c
- The connection the call is made onTypes.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.public java.lang.Boolean getAllowCaching(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
c
- The connection the call is made onTypes.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.public Types.OnBoot getOnBoot(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
c
- The connection the call is made onTypes.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.public Pool getMetadataOfPool(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
c
- The connection the call is made onTypes.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.public java.lang.Boolean getMetadataLatest(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
c
- The connection the call is made onTypes.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.public java.lang.Boolean getIsToolsIso(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
c
- The connection the call is made onTypes.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.public java.lang.Boolean getCbtEnabled(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
c
- The connection the call is made onTypes.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.public void setOtherConfig(Connection c, java.util.Map<java.lang.String,java.lang.String> otherConfig) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
c
- The connection the call is made onotherConfig
- New value to setTypes.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.public void addToOtherConfig(Connection c, java.lang.String key, java.lang.String value) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
c
- The connection the call is made onkey
- Key to addvalue
- Value to addTypes.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.public void removeFromOtherConfig(Connection c, java.lang.String key) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
c
- The connection the call is made onkey
- Key to removeTypes.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.public void setXenstoreData(Connection c, java.util.Map<java.lang.String,java.lang.String> xenstoreData) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
c
- The connection the call is made onxenstoreData
- New value to setTypes.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.public void addToXenstoreData(Connection c, java.lang.String key, java.lang.String value) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
c
- The connection the call is made onkey
- Key to addvalue
- Value to addTypes.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.public void removeFromXenstoreData(Connection c, java.lang.String key) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
c
- The connection the call is made onkey
- Key to removeTypes.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.public void setSmConfig(Connection c, java.util.Map<java.lang.String,java.lang.String> smConfig) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
c
- The connection the call is made onsmConfig
- New value to setTypes.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.public void addToSmConfig(Connection c, java.lang.String key, java.lang.String value) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
c
- The connection the call is made onkey
- Key to addvalue
- Value to addTypes.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.public void removeFromSmConfig(Connection c, java.lang.String key) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
c
- The connection the call is made onkey
- Key to removeTypes.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.public void setTags(Connection c, java.util.Set<java.lang.String> tags) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
c
- The connection the call is made ontags
- New value to setTypes.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.public void addTags(Connection c, java.lang.String value) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
c
- The connection the call is made onvalue
- New value to addTypes.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.public void removeTags(Connection c, java.lang.String value) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
c
- The connection the call is made onvalue
- Value to removeTypes.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.public Task snapshotAsync(Connection c, java.util.Map<java.lang.String,java.lang.String> driverParams) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
c
- The connection the call is made ondriverParams
- 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.Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.public VDI snapshot(Connection c, java.util.Map<java.lang.String,java.lang.String> driverParams) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
c
- The connection the call is made ondriverParams
- 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.Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.public Task createCloneAsync(Connection c, java.util.Map<java.lang.String,java.lang.String> driverParams) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
c
- The connection the call is made ondriverParams
- 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.Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.public VDI createClone(Connection c, java.util.Map<java.lang.String,java.lang.String> driverParams) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
c
- The connection the call is made ondriverParams
- 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.Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.public Task resizeAsync(Connection c, java.lang.Long size) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
c
- The connection the call is made onsize
- The new size of the VDITypes.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.public void resize(Connection c, java.lang.Long size) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
c
- The connection the call is made onsize
- The new size of the VDITypes.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.public Task resizeOnlineAsync(Connection c, java.lang.Long size) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
c
- The connection the call is made onsize
- The new size of the VDITypes.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.public void resizeOnline(Connection c, java.lang.Long size) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
c
- The connection the call is made onsize
- The new size of the VDITypes.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.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
c
- The connection the call is made onuuid
- The uuid of the disk to introducenameLabel
- The name of the disk recordnameDescription
- The description of the disk recordSR
- The SR that the VDI is intype
- The type of the VDIsharable
- true if this disk may be sharedreadOnly
- true if this disk may ONLY be mounted read-onlyotherConfig
- additional configurationlocation
- location informationxenstoreData
- Data to insert into xenstoresmConfig
- Storage-specific configTypes.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.Types.SrOperationNotSupported
- The SR backend does not support the operation (check the SR's allowed operations)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
c
- The connection the call is made onuuid
- The uuid of the disk to introducenameLabel
- The name of the disk recordnameDescription
- The description of the disk recordSR
- The SR that the VDI is intype
- The type of the VDIsharable
- true if this disk may be sharedreadOnly
- true if this disk may ONLY be mounted read-onlyotherConfig
- additional configurationlocation
- location informationxenstoreData
- Data to insert into xenstoresmConfig
- Storage-specific configTypes.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.Types.SrOperationNotSupported
- The SR backend does not support the operation (check the SR's allowed operations)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
c
- The connection the call is made onuuid
- The uuid of the disk to introducenameLabel
- The name of the disk recordnameDescription
- The description of the disk recordSR
- The SR that the VDI is intype
- The type of the VDIsharable
- true if this disk may be sharedreadOnly
- true if this disk may ONLY be mounted read-onlyotherConfig
- additional configurationlocation
- location informationxenstoreData
- Data to insert into xenstoresmConfig
- Storage-specific configmanaged
- 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.Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.Types.SrOperationNotSupported
- The SR backend does not support the operation (check the SR's allowed operations)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
c
- The connection the call is made onuuid
- The uuid of the disk to introducenameLabel
- The name of the disk recordnameDescription
- The description of the disk recordSR
- The SR that the VDI is intype
- The type of the VDIsharable
- true if this disk may be sharedreadOnly
- true if this disk may ONLY be mounted read-onlyotherConfig
- additional configurationlocation
- location informationxenstoreData
- Data to insert into xenstoresmConfig
- Storage-specific configmanaged
- 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.Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.Types.SrOperationNotSupported
- The SR backend does not support the operation (check the SR's allowed operations)public Task updateAsync(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException, Types.SrOperationNotSupported
c
- The connection the call is made onTypes.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.Types.SrOperationNotSupported
- The SR backend does not support the operation (check the SR's allowed operations)public void update(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException, Types.SrOperationNotSupported
c
- The connection the call is made onTypes.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.Types.SrOperationNotSupported
- The SR backend does not support the operation (check the SR's allowed operations)public Task copyAsync(Connection c, SR sr) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException, Types.VdiReadonly, Types.VdiTooSmall, Types.VdiNotSparse
c
- The connection the call is made onsr
- The destination SR (only required if the destination VDI is not specifiedTypes.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.Types.VdiReadonly
- The operation required write access but this VDI is read-onlyTypes.VdiTooSmall
- The VDI is too small. Please resize it to at least the minimum size.Types.VdiNotSparse
- The VDI is not stored using a sparse format. It is not possible to query and manipulate only the changed blocks (or 'block differences' or 'disk deltas') between two VDIs. Please select a VDI which uses a sparse-aware technology such as VHD.public VDI copy(Connection c, SR sr) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException, Types.VdiReadonly, Types.VdiTooSmall, Types.VdiNotSparse
c
- The connection the call is made onsr
- The destination SR (only required if the destination VDI is not specifiedTypes.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.Types.VdiReadonly
- The operation required write access but this VDI is read-onlyTypes.VdiTooSmall
- The VDI is too small. Please resize it to at least the minimum size.Types.VdiNotSparse
- The VDI is not stored using a sparse format. It is not possible to query and manipulate only the changed blocks (or 'block differences' or 'disk deltas') between two VDIs. Please select a VDI which uses a sparse-aware technology such as VHD.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
c
- The connection the call is made onsr
- The destination SR (only required if the destination VDI is not specifiedbaseVdi
- 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.Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.Types.VdiReadonly
- The operation required write access but this VDI is read-onlyTypes.VdiTooSmall
- The VDI is too small. Please resize it to at least the minimum size.Types.VdiNotSparse
- The VDI is not stored using a sparse format. It is not possible to query and manipulate only the changed blocks (or 'block differences' or 'disk deltas') between two VDIs. Please select a VDI which uses a sparse-aware technology such as VHD.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
c
- The connection the call is made onsr
- The destination SR (only required if the destination VDI is not specifiedbaseVdi
- 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.Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.Types.VdiReadonly
- The operation required write access but this VDI is read-onlyTypes.VdiTooSmall
- The VDI is too small. Please resize it to at least the minimum size.Types.VdiNotSparse
- The VDI is not stored using a sparse format. It is not possible to query and manipulate only the changed blocks (or 'block differences' or 'disk deltas') between two VDIs. Please select a VDI which uses a sparse-aware technology such as VHD.public Task forgetAsync(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
c
- The connection the call is made onTypes.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.public void forget(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
c
- The connection the call is made onTypes.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.public void setSharable(Connection c, java.lang.Boolean value) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
c
- The connection the call is made onvalue
- The new value of the VDI's sharable fieldTypes.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.public void setReadOnly(Connection c, java.lang.Boolean value) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
c
- The connection the call is made onvalue
- The new value of the VDI's read_only fieldTypes.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.public Task setNameLabelAsync(Connection c, java.lang.String value) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
c
- The connection the call is made onvalue
- The name lable for the VDITypes.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.public void setNameLabel(Connection c, java.lang.String value) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
c
- The connection the call is made onvalue
- The name lable for the VDITypes.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.public Task setNameDescriptionAsync(Connection c, java.lang.String value) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
c
- The connection the call is made onvalue
- The name description for the VDITypes.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.public void setNameDescription(Connection c, java.lang.String value) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
c
- The connection the call is made onvalue
- The name description for the VDITypes.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.public Task setOnBootAsync(Connection c, Types.OnBoot value) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
c
- The connection the call is made onvalue
- The value to setTypes.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.public void setOnBoot(Connection c, Types.OnBoot value) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
c
- The connection the call is made onvalue
- The value to setTypes.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.public Task setAllowCachingAsync(Connection c, java.lang.Boolean value) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
c
- The connection the call is made onvalue
- The value to setTypes.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.public void setAllowCaching(Connection c, java.lang.Boolean value) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
c
- The connection the call is made onvalue
- The value to setTypes.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.public Task openDatabaseAsync(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
c
- The connection the call is made onTypes.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.public Session openDatabase(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
c
- The connection the call is made onTypes.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.public Task readDatabasePoolUuidAsync(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
c
- The connection the call is made onTypes.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.public java.lang.String readDatabasePoolUuid(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
c
- The connection the call is made onTypes.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.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
c
- The connection the call is made onsr
- The destination SRoptions
- Other parametersTypes.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.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
c
- The connection the call is made onsr
- The destination SRoptions
- Other parametersTypes.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.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
c
- The connection the call is made onTypes.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.Types.SrOperationNotSupported
- The SR backend does not support the operation (check the SR's allowed operations)Types.VdiMissing
- This operation cannot be performed because the specified VDI could not be found on the storage substrateTypes.SrNotAttached
- The SR is not attached.Types.SrHasNoPbds
- The SR has no attached PBDsTypes.OperationNotAllowed
- You attempted an operation that was not allowed.Types.VdiIncompatibleType
- This operation cannot be performed because the specified VDI is of an incompatible type (eg: an HA statefile cannot be attached to a guest)Types.VdiOnBootModeIncompatibleWithOperation
- This operation is not permitted on VDIs in the 'on-boot=reset' mode, or on VMs having such VDIs.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
c
- The connection the call is made onTypes.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.Types.SrOperationNotSupported
- The SR backend does not support the operation (check the SR's allowed operations)Types.VdiMissing
- This operation cannot be performed because the specified VDI could not be found on the storage substrateTypes.SrNotAttached
- The SR is not attached.Types.SrHasNoPbds
- The SR has no attached PBDsTypes.OperationNotAllowed
- You attempted an operation that was not allowed.Types.VdiIncompatibleType
- This operation cannot be performed because the specified VDI is of an incompatible type (eg: an HA statefile cannot be attached to a guest)Types.VdiOnBootModeIncompatibleWithOperation
- This operation is not permitted on VDIs in the 'on-boot=reset' mode, or on VMs having such VDIs.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
c
- The connection the call is made onTypes.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.Types.SrOperationNotSupported
- The SR backend does not support the operation (check the SR's allowed operations)Types.VdiMissing
- This operation cannot be performed because the specified VDI could not be found on the storage substrateTypes.SrNotAttached
- The SR is not attached.Types.SrHasNoPbds
- The SR has no attached PBDsTypes.OperationNotAllowed
- You attempted an operation that was not allowed.Types.VdiIncompatibleType
- This operation cannot be performed because the specified VDI is of an incompatible type (eg: an HA statefile cannot be attached to a guest)Types.VdiOnBootModeIncompatibleWithOperation
- This operation is not permitted on VDIs in the 'on-boot=reset' mode, or on VMs having such VDIs.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
c
- The connection the call is made onTypes.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.Types.SrOperationNotSupported
- The SR backend does not support the operation (check the SR's allowed operations)Types.VdiMissing
- This operation cannot be performed because the specified VDI could not be found on the storage substrateTypes.SrNotAttached
- The SR is not attached.Types.SrHasNoPbds
- The SR has no attached PBDsTypes.OperationNotAllowed
- You attempted an operation that was not allowed.Types.VdiIncompatibleType
- This operation cannot be performed because the specified VDI is of an incompatible type (eg: an HA statefile cannot be attached to a guest)Types.VdiOnBootModeIncompatibleWithOperation
- This operation is not permitted on VDIs in the 'on-boot=reset' mode, or on VMs having such VDIs.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
c
- The connection the call is made onTypes.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.Types.SrOperationNotSupported
- The SR backend does not support the operation (check the SR's allowed operations)Types.VdiMissing
- This operation cannot be performed because the specified VDI could not be found on the storage substrateTypes.SrNotAttached
- The SR is not attached.Types.SrHasNoPbds
- The SR has no attached PBDsTypes.OperationNotAllowed
- You attempted an operation that was not allowed.Types.VdiIncompatibleType
- This operation cannot be performed because the specified VDI is of an incompatible type (eg: an HA statefile cannot be attached to a guest)Types.VdiNoCbtMetadata
- The requested operation is not allowed because the specified VDI does not have changed block tracking metadata.Types.VdiInUse
- This operation cannot be performed because this VDI is in use by some other operationTypes.VdiIsAPhysicalDevice
- The operation cannot be performed on physical devicepublic 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
c
- The connection the call is made onTypes.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.Types.SrOperationNotSupported
- The SR backend does not support the operation (check the SR's allowed operations)Types.VdiMissing
- This operation cannot be performed because the specified VDI could not be found on the storage substrateTypes.SrNotAttached
- The SR is not attached.Types.SrHasNoPbds
- The SR has no attached PBDsTypes.OperationNotAllowed
- You attempted an operation that was not allowed.Types.VdiIncompatibleType
- This operation cannot be performed because the specified VDI is of an incompatible type (eg: an HA statefile cannot be attached to a guest)Types.VdiNoCbtMetadata
- The requested operation is not allowed because the specified VDI does not have changed block tracking metadata.Types.VdiInUse
- This operation cannot be performed because this VDI is in use by some other operationTypes.VdiIsAPhysicalDevice
- The operation cannot be performed on physical devicepublic 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
c
- The connection the call is made onvdiTo
- The second VDI.Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.Types.SrOperationNotSupported
- The SR backend does not support the operation (check the SR's allowed operations)Types.VdiMissing
- This operation cannot be performed because the specified VDI could not be found on the storage substrateTypes.SrNotAttached
- The SR is not attached.Types.SrHasNoPbds
- The SR has no attached PBDsTypes.VdiInUse
- This operation cannot be performed because this VDI is in use by some other operationpublic 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
c
- The connection the call is made onvdiTo
- The second VDI.Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.Types.SrOperationNotSupported
- The SR backend does not support the operation (check the SR's allowed operations)Types.VdiMissing
- This operation cannot be performed because the specified VDI could not be found on the storage substrateTypes.SrNotAttached
- The SR is not attached.Types.SrHasNoPbds
- The SR has no attached PBDsTypes.VdiInUse
- This operation cannot be performed because this VDI is in use by some other operationpublic java.util.Set<VdiNbdServerInfo.Record> getNbdInfo(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException, Types.VdiIncompatibleType
c
- The connection the call is made onTypes.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.Types.VdiIncompatibleType
- This operation cannot be performed because the specified VDI is of an incompatible type (eg: an HA statefile cannot be attached to a guest)public static java.util.Set<VDI> getAll(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
c
- The connection the call is made onTypes.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.public static java.util.Map<VDI,VDI.Record> getAllRecords(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
c
- The connection the call is made onTypes.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.