Package com.xensource.xenapi
Class VDI
java.lang.Object
com.xensource.xenapi.XenAPIObject
com.xensource.xenapi.VDI
A virtual disk image
First published in XenServer 4.0.
- Author:
- Cloud Software Group, Inc.
-
Nested Class Summary
Nested Classes -
Field Summary
Fields -
Method Summary
Modifier and TypeMethodDescriptionvoid
addTags
(Connection c, String value) Add the given value to the tags field of the given VDI.void
addToOtherConfig
(Connection c, String key, String value) Add the given key-value pair to the other_config field of the given VDI.void
addToSmConfig
(Connection c, String key, String value) Add the given key-value pair to the sm_config field of the given VDI.void
addToXenstoreData
(Connection c, String key, String value) Add the given key-value pair to the xenstore_data field of the given 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.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.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.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.Take an exact copy of the VDI and return a reference to the new disk.createClone
(Connection c, Map<String, String> driverParams) Take an exact copy of the VDI and return a reference to the new disk.Take an exact copy of the VDI and return a reference to the new disk.createCloneAsync
(Connection c, Map<String, String> driverParams) Take an exact copy of the VDI and return a reference to the new disk.void
Delete the data of the snapshot VDI, but keep its changed block tracking metadata.Delete the data of the snapshot VDI, but keep its changed block tracking metadata.void
Destroy the specified VDI instance.Destroy the specified VDI instance.void
Disable changed block tracking for the VDI.Disable changed block tracking for the VDI.void
Enable changed block tracking for the VDI.Enable changed block tracking for the VDI.boolean
If obj is a VDI, compares XenAPI references for equality.void
forget
(Connection c) Removes a VDI record from the database Minimum allowed role: vm-admin First published in XenServer 4.0.Removes a VDI record from the database Minimum allowed role: vm-admin First published in XenServer 4.0.getAll
(Connection c) Return a list of all the VDIs known to the system.Get the allow_caching field of the given VDI.Get the allowed_operations field of the given VDI.static Map<VDI,
VDI.Record> Return a map of VDI references to VDI records for all VDIs known to the system.getByNameLabel
(Connection c, String label) Get all the VDI instances with the given label.static VDI
getByUuid
(Connection c, String uuid) Get a reference to the VDI instance with the specified UUID.Get the cbt_enabled field of the given VDI.Get the crash_dumps field of the given VDI.Get the current_operations field of the given VDI.Get the is_a_snapshot field of the given VDI.Get the is_tools_iso field of the given VDI.Get the location field of the given VDI.Get the managed field of the given VDI.Get the metadata_latest field of the given VDI.Get the metadata_of_pool field of the given VDI.Get the missing field of the given VDI.Get the name/description field of the given VDI.Get the name/label field of the given VDI.Get details specifying how to access this VDI via a Network Block Device server.Get the on_boot field of the given VDI.Get the other_config field of the given VDI.Deprecated.since XenServer 7.1Get the physical_utilisation field of the given VDI.Get the read_only field of the given VDI.Get a record containing the current state of the given VDI.Get the sharable field of the given VDI.Get the sm_config field of the given VDI.Get the snapshot_of field of the given VDI.Get the snapshots field of the given VDI.Get the snapshot_time field of the given VDI.getSR
(Connection c) Get the SR field of the given VDI.Get the storage_lock field of the given VDI.Get the tags field of the given VDI.Get the type field of the given VDI.Get the uuid field of the given VDI.Get the VBDs field of the given VDI.Get the virtual_size field of the given VDI.Get the xenstore_data field of the given VDI.int
hashCode()
static VDI
introduce
(Connection c, String uuid, String nameLabel, String nameDescription, SR SR, Types.VdiType type, Boolean sharable, Boolean readOnly, Map<String, String> otherConfig, String location, Map<String, String> xenstoreData) Create a new VDI record in the database only Minimum allowed role: vm-admin First published in XenServer 4.1.static VDI
introduce
(Connection c, String uuid, String nameLabel, String nameDescription, SR SR, Types.VdiType type, Boolean sharable, Boolean readOnly, Map<String, String> otherConfig, String location, Map<String, String> xenstoreData, Map<String, String> smConfig) Create a new VDI record in the database only Minimum allowed role: vm-admin First published in XenServer 4.1.static VDI
introduce
(Connection c, String uuid, String nameLabel, String nameDescription, SR SR, Types.VdiType type, Boolean sharable, Boolean readOnly, Map<String, String> otherConfig, String location, Map<String, String> xenstoreData, Map<String, String> smConfig, Boolean managed, Long virtualSize, Long physicalUtilisation, Pool metadataOfPool, Boolean isASnapshot, Date snapshotTime, VDI snapshotOf) Create a new VDI record in the database only Minimum allowed role: vm-admin First published in XenServer 4.1.static Task
introduceAsync
(Connection c, String uuid, String nameLabel, String nameDescription, SR SR, Types.VdiType type, Boolean sharable, Boolean readOnly, Map<String, String> otherConfig, String location, Map<String, String> xenstoreData) Create a new VDI record in the database only Minimum allowed role: vm-admin First published in XenServer 4.1.static Task
introduceAsync
(Connection c, String uuid, String nameLabel, String nameDescription, SR SR, Types.VdiType type, Boolean sharable, Boolean readOnly, Map<String, String> otherConfig, String location, Map<String, String> xenstoreData, Map<String, String> smConfig) Create a new VDI record in the database only Minimum allowed role: vm-admin First published in XenServer 4.1.static Task
introduceAsync
(Connection c, String uuid, String nameLabel, String nameDescription, SR SR, Types.VdiType type, Boolean sharable, Boolean readOnly, Map<String, String> otherConfig, String location, Map<String, String> xenstoreData, Map<String, String> smConfig, Boolean managed, Long virtualSize, Long physicalUtilisation, Pool metadataOfPool, Boolean isASnapshot, Date snapshotTime, VDI snapshotOf) Create a new VDI record in the database only Minimum allowed role: vm-admin First published in XenServer 4.1.listChangedBlocks
(Connection c, VDI vdiTo) Compare two VDIs in 64k block increments and report which blocks differ.listChangedBlocksAsync
(Connection c, VDI vdiTo) Compare two VDIs in 64k block increments and report which blocks differ.Load the metadata found on the supplied VDI and return a session reference which can be used in API calls to query its contents.Load the metadata found on the supplied VDI and return a session reference which can be used in API calls to query its contents.poolMigrate
(Connection c, SR sr, Map<String, String> options) Migrate a VDI, which may be attached to a running guest, to a different SR.poolMigrateAsync
(Connection c, SR sr, Map<String, String> options) Migrate a VDI, which may be attached to a running guest, to a different SR.Check the VDI cache for the pool UUID of the database on this VDI.Check the VDI cache for the pool UUID of the database on this VDI.void
removeFromOtherConfig
(Connection c, String key) Remove the given key and its corresponding value from the other_config field of the given VDI.void
removeFromSmConfig
(Connection c, String key) Remove the given key and its corresponding value from the sm_config field of the given VDI.void
removeFromXenstoreData
(Connection c, String key) Remove the given key and its corresponding value from the xenstore_data field of the given VDI.void
removeTags
(Connection c, String value) Remove the given value from the tags field of the given VDI.void
resize
(Connection c, Long size) Resize the VDI.resizeAsync
(Connection c, Long size) Resize the VDI.void
resizeOnline
(Connection c, Long size) Deprecated.since XenServer 7.3resizeOnlineAsync
(Connection c, Long size) Deprecated.since XenServer 7.3void
setAllowCaching
(Connection c, Boolean value) Set the value of the allow_caching parameter.setAllowCachingAsync
(Connection c, Boolean value) Set the value of the allow_caching parameter.void
setNameDescription
(Connection c, String value) Set the name description of the VDI.setNameDescriptionAsync
(Connection c, String value) Set the name description of the VDI.void
setNameLabel
(Connection c, String value) Set the name label of the VDI.setNameLabelAsync
(Connection c, String value) Set the name label of the VDI.void
setOnBoot
(Connection c, Types.OnBoot value) Set the value of the on_boot parameter.setOnBootAsync
(Connection c, Types.OnBoot value) Set the value of the on_boot parameter.void
setOtherConfig
(Connection c, Map<String, String> otherConfig) Set the other_config field of the given VDI.void
setReadOnly
(Connection c, Boolean value) Sets the VDI's read_only field Minimum allowed role: vm-admin First published in XenServer 4.0.void
setSharable
(Connection c, Boolean value) Sets the VDI's sharable field Minimum allowed role: vm-admin First published in XenServer 5.5.void
setSmConfig
(Connection c, Map<String, String> smConfig) Set the sm_config field of the given VDI.void
setTags
(Connection c, Set<String> tags) Set the tags field of the given VDI.void
setXenstoreData
(Connection c, Map<String, String> xenstoreData) Set the xenstore_data field of the given VDI.Take a read-only snapshot of the VDI, returning a reference to the snapshot.snapshot
(Connection c, Map<String, String> driverParams) Take a read-only snapshot of the VDI, returning a reference to the snapshot.Take a read-only snapshot of the VDI, returning a reference to the snapshot.snapshotAsync
(Connection c, Map<String, String> driverParams) Take a read-only snapshot of the VDI, returning a reference to the snapshot.void
update
(Connection c) Ask the storage backend to refresh the fields in the VDI object Minimum allowed role: vm-admin First published in XenServer 4.1.1.Ask the storage backend to refresh the fields in the VDI object Minimum allowed role: vm-admin First published in XenServer 4.1.1.Methods inherited from class com.xensource.xenapi.XenAPIObject
isNull
-
Field Details
-
ref
The XenAPI reference (OpaqueRef) to this object.
-
-
Method Details
-
toWireString
- Specified by:
toWireString
in classXenAPIObject
- Returns:
- The XenAPI reference (OpaqueRef) to this object.
-
equals
If obj is a VDI, compares XenAPI references for equality. -
hashCode
public int hashCode() -
getRecord
public VDI.Record getRecord(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get a record containing the current state of the given VDI. Minimum allowed role: read-only First published in XenServer 4.0.- Parameters:
c
- The connection the call is made on- Returns:
- all fields from the object
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getByUuid
public static VDI getByUuid(Connection c, String uuid) throws Types.BadServerResponse, Types.XenAPIException, IOException Get a reference to the VDI instance with the specified UUID. Minimum allowed role: read-only First published in XenServer 4.0.- Parameters:
c
- The connection the call is made onuuid
- UUID of object to return- Returns:
- reference to the object
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
create
public static VDI create(Connection c, VDI.Record record) throws Types.BadServerResponse, Types.XenAPIException, IOException Create a new VDI instance, and return its handle. Minimum allowed role: vm-admin First published in XenServer 4.0.- Parameters:
c
- The connection the call is made onrecord
- All constructor arguments- Returns:
- reference to the newly created object
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
createAsync
public static Task createAsync(Connection c, VDI.Record record) throws Types.BadServerResponse, Types.XenAPIException, IOException Create a new VDI instance, and return its handle. Minimum allowed role: vm-admin First published in XenServer 4.0.- Parameters:
c
- The connection the call is made onrecord
- All constructor arguments- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
destroy
public void destroy(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Destroy the specified VDI instance. Minimum allowed role: vm-admin First published in XenServer 4.0.- Parameters:
c
- The connection the call is made on- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
destroyAsync
public Task destroyAsync(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Destroy the specified VDI instance. Minimum allowed role: vm-admin First published in XenServer 4.0.- Parameters:
c
- The connection the call is made on- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getByNameLabel
public static Set<VDI> getByNameLabel(Connection c, String label) throws Types.BadServerResponse, Types.XenAPIException, IOException Get all the VDI instances with the given label. Minimum allowed role: read-only First published in XenServer 4.0.- Parameters:
c
- The connection the call is made onlabel
- label of object to return- Returns:
- references to objects with matching names
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getUuid
public String getUuid(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the uuid field of the given VDI. Minimum allowed role: read-only First published in XenServer 4.0.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getNameLabel
public String getNameLabel(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the name/label field of the given VDI. Minimum allowed role: read-only First published in XenServer 4.0.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getNameDescription
public String getNameDescription(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the name/description field of the given VDI. Minimum allowed role: read-only First published in XenServer 4.0.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getAllowedOperations
public Set<Types.VdiOperations> getAllowedOperations(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the allowed_operations field of the given VDI. Minimum allowed role: read-only First published in XenServer 4.0.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getCurrentOperations
public Map<String,Types.VdiOperations> getCurrentOperations(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the current_operations field of the given VDI. Minimum allowed role: read-only First published in XenServer 4.0.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getSR
Get the SR field of the given VDI. Minimum allowed role: read-only First published in XenServer 4.0.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getVBDs
public Set<VBD> getVBDs(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the VBDs field of the given VDI. Minimum allowed role: read-only First published in XenServer 4.0.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getCrashDumps
public Set<Crashdump> getCrashDumps(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the crash_dumps field of the given VDI. Minimum allowed role: read-only First published in XenServer 4.0.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getVirtualSize
public Long getVirtualSize(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the virtual_size field of the given VDI. Minimum allowed role: read-only First published in XenServer 4.0.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getPhysicalUtilisation
public Long getPhysicalUtilisation(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the physical_utilisation field of the given VDI. Minimum allowed role: read-only First published in XenServer 4.0.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getType
public Types.VdiType getType(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the type field of the given VDI. Minimum allowed role: read-only First published in XenServer 4.0.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getSharable
public Boolean getSharable(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the sharable field of the given VDI. Minimum allowed role: read-only First published in XenServer 4.0.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getReadOnly
public Boolean getReadOnly(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the read_only field of the given VDI. Minimum allowed role: read-only First published in XenServer 4.0.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getOtherConfig
public Map<String,String> getOtherConfig(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the other_config field of the given VDI. Minimum allowed role: read-only First published in XenServer 4.0.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getStorageLock
public Boolean getStorageLock(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the storage_lock field of the given VDI. Minimum allowed role: read-only First published in XenServer 4.0.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getLocation
public String getLocation(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the location field of the given VDI. Minimum allowed role: read-only First published in XenServer 4.1.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getManaged
public Boolean getManaged(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the managed field of the given VDI. Minimum allowed role: read-only First published in XenServer 4.0.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getMissing
public Boolean getMissing(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the missing field of the given VDI. Minimum allowed role: read-only First published in XenServer 4.0.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getParent
@Deprecated(since="XenServer 7.1") public VDI getParent(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Deprecated.since XenServer 7.1Get the parent field of the given VDI. Minimum allowed role: read-only First published in XenServer 4.0.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getXenstoreData
public Map<String,String> getXenstoreData(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the xenstore_data field of the given VDI. Minimum allowed role: read-only First published in XenServer 4.1.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getSmConfig
public Map<String,String> getSmConfig(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the sm_config field of the given VDI. Minimum allowed role: read-only First published in XenServer 4.1.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getIsASnapshot
public Boolean getIsASnapshot(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the is_a_snapshot field of the given VDI. Minimum allowed role: read-only First published in XenServer 5.0.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getSnapshotOf
public VDI getSnapshotOf(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the snapshot_of field of the given VDI. Minimum allowed role: read-only First published in XenServer 5.0.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getSnapshots
public Set<VDI> getSnapshots(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the snapshots field of the given VDI. Minimum allowed role: read-only First published in XenServer 5.0.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getSnapshotTime
public Date getSnapshotTime(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the snapshot_time field of the given VDI. Minimum allowed role: read-only First published in XenServer 5.0.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getTags
public Set<String> getTags(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the tags field of the given VDI. Minimum allowed role: read-only First published in XenServer 5.0.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getAllowCaching
public Boolean getAllowCaching(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the allow_caching field of the given VDI. Minimum allowed role: read-only First published in XenServer 5.6 FP1.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getOnBoot
public Types.OnBoot getOnBoot(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the on_boot field of the given VDI. Minimum allowed role: read-only First published in XenServer 5.6 FP1.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getMetadataOfPool
public Pool getMetadataOfPool(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the metadata_of_pool field of the given VDI. Minimum allowed role: read-only First published in XenServer 6.0.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getMetadataLatest
public Boolean getMetadataLatest(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the metadata_latest field of the given VDI. Minimum allowed role: read-only First published in XenServer 6.0.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getIsToolsIso
public Boolean getIsToolsIso(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the is_tools_iso field of the given VDI. Minimum allowed role: read-only First published in XenServer 7.0.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getCbtEnabled
public Boolean getCbtEnabled(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the cbt_enabled field of the given VDI. Minimum allowed role: read-only First published in XenServer 7.3.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
setOtherConfig
public void setOtherConfig(Connection c, Map<String, String> otherConfig) throws Types.BadServerResponse, Types.XenAPIException, IOExceptionSet the other_config field of the given VDI. Minimum allowed role: vm-admin First published in XenServer 4.0.- Parameters:
c
- The connection the call is made onotherConfig
- New value to set- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
addToOtherConfig
public void addToOtherConfig(Connection c, String key, String value) throws Types.BadServerResponse, Types.XenAPIException, IOException Add the given key-value pair to the other_config field of the given VDI. Minimum allowed role: vm-admin First published in XenServer 4.0.- Parameters:
c
- The connection the call is made onkey
- Key to addvalue
- Value to add- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
removeFromOtherConfig
public void removeFromOtherConfig(Connection c, String key) throws Types.BadServerResponse, Types.XenAPIException, IOException 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. Minimum allowed role: vm-admin First published in XenServer 4.0.- Parameters:
c
- The connection the call is made onkey
- Key to remove- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
setXenstoreData
public void setXenstoreData(Connection c, Map<String, String> xenstoreData) throws Types.BadServerResponse, Types.XenAPIException, IOExceptionSet the xenstore_data field of the given VDI. Minimum allowed role: vm-admin First published in XenServer 4.1.- Parameters:
c
- The connection the call is made onxenstoreData
- New value to set- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
addToXenstoreData
public void addToXenstoreData(Connection c, String key, String value) throws Types.BadServerResponse, Types.XenAPIException, IOException Add the given key-value pair to the xenstore_data field of the given VDI. Minimum allowed role: vm-admin First published in XenServer 4.1.- Parameters:
c
- The connection the call is made onkey
- Key to addvalue
- Value to add- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
removeFromXenstoreData
public void removeFromXenstoreData(Connection c, String key) throws Types.BadServerResponse, Types.XenAPIException, IOException 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. Minimum allowed role: vm-admin First published in XenServer 4.1.- Parameters:
c
- The connection the call is made onkey
- Key to remove- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
setSmConfig
public void setSmConfig(Connection c, Map<String, String> smConfig) throws Types.BadServerResponse, Types.XenAPIException, IOExceptionSet the sm_config field of the given VDI. Minimum allowed role: vm-admin First published in XenServer 4.1.- Parameters:
c
- The connection the call is made onsmConfig
- New value to set- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
addToSmConfig
public void addToSmConfig(Connection c, String key, String value) throws Types.BadServerResponse, Types.XenAPIException, IOException Add the given key-value pair to the sm_config field of the given VDI. Minimum allowed role: vm-admin First published in XenServer 4.1.- Parameters:
c
- The connection the call is made onkey
- Key to addvalue
- Value to add- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
removeFromSmConfig
public void removeFromSmConfig(Connection c, String key) throws Types.BadServerResponse, Types.XenAPIException, IOException 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. Minimum allowed role: vm-admin First published in XenServer 4.1.- Parameters:
c
- The connection the call is made onkey
- Key to remove- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
setTags
public void setTags(Connection c, Set<String> tags) throws Types.BadServerResponse, Types.XenAPIException, IOException Set the tags field of the given VDI. Minimum allowed role: vm-operator First published in XenServer 5.0.- Parameters:
c
- The connection the call is made ontags
- New value to set- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
addTags
public void addTags(Connection c, String value) throws Types.BadServerResponse, Types.XenAPIException, IOException Add the given value to the tags field of the given VDI. If the value is already in that Set, then do nothing. Minimum allowed role: vm-operator First published in XenServer 5.0.- Parameters:
c
- The connection the call is made onvalue
- New value to add- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
removeTags
public void removeTags(Connection c, String value) throws Types.BadServerResponse, Types.XenAPIException, IOException Remove the given value from the tags field of the given VDI. If the value is not in that Set, then do nothing. Minimum allowed role: vm-operator First published in XenServer 5.0.- Parameters:
c
- The connection the call is made onvalue
- Value to remove- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
snapshot
public VDI snapshot(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException 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. Minimum allowed role: vm-admin First published in XenServer 4.0.- Parameters:
c
- The connection the call is made on- Returns:
- The ID of the newly created VDI.
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
snapshot
public VDI snapshot(Connection c, Map<String, String> driverParams) throws Types.BadServerResponse, Types.XenAPIException, IOExceptionTake 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. Minimum allowed role: vm-admin First published in XenServer 4.0.- Parameters:
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.- Returns:
- The ID of the newly created VDI.
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
snapshotAsync
public Task snapshotAsync(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException 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. Minimum allowed role: vm-admin First published in XenServer 4.0.- Parameters:
c
- The connection the call is made on- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
snapshotAsync
public Task snapshotAsync(Connection c, Map<String, String> driverParams) throws Types.BadServerResponse, Types.XenAPIException, IOExceptionTake 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. Minimum allowed role: vm-admin First published in XenServer 4.0.- Parameters:
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.- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
createClone
public VDI createClone(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException 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. Minimum allowed role: vm-admin First published in XenServer 4.0.- Parameters:
c
- The connection the call is made on- Returns:
- The ID of the newly created VDI.
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
createClone
public VDI createClone(Connection c, Map<String, String> driverParams) throws Types.BadServerResponse, Types.XenAPIException, IOExceptionTake 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. Minimum allowed role: vm-admin First published in XenServer 4.0.- Parameters:
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.- Returns:
- The ID of the newly created VDI.
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
createCloneAsync
public Task createCloneAsync(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException 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. Minimum allowed role: vm-admin First published in XenServer 4.0.- Parameters:
c
- The connection the call is made on- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
createCloneAsync
public Task createCloneAsync(Connection c, Map<String, String> driverParams) throws Types.BadServerResponse, Types.XenAPIException, IOExceptionTake 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. Minimum allowed role: vm-admin First published in XenServer 4.0.- Parameters:
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.- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
resize
public void resize(Connection c, Long size) throws Types.BadServerResponse, Types.XenAPIException, IOException Resize the VDI. Minimum allowed role: vm-admin First published in XenServer 4.0.- Parameters:
c
- The connection the call is made onsize
- The new size of the VDI- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
resizeAsync
public Task resizeAsync(Connection c, Long size) throws Types.BadServerResponse, Types.XenAPIException, IOException Resize the VDI. Minimum allowed role: vm-admin First published in XenServer 4.0.- Parameters:
c
- The connection the call is made onsize
- The new size of the VDI- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
resizeOnline
@Deprecated(since="XenServer 7.3") public void resizeOnline(Connection c, Long size) throws Types.BadServerResponse, Types.XenAPIException, IOException Deprecated.since XenServer 7.3Resize the VDI which may or may not be attached to running guests. Minimum allowed role: vm-admin First published in XenServer 4.0.- Parameters:
c
- The connection the call is made onsize
- The new size of the VDI- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
resizeOnlineAsync
@Deprecated(since="XenServer 7.3") public Task resizeOnlineAsync(Connection c, Long size) throws Types.BadServerResponse, Types.XenAPIException, IOException Deprecated.since XenServer 7.3Resize the VDI which may or may not be attached to running guests. Minimum allowed role: vm-admin First published in XenServer 4.0.- Parameters:
c
- The connection the call is made onsize
- The new size of the VDI- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
introduce
public static VDI introduce(Connection c, String uuid, String nameLabel, String nameDescription, SR SR, Types.VdiType type, Boolean sharable, Boolean readOnly, Map<String, String> otherConfig, String location, Map<String, throws Types.BadServerResponse, Types.XenAPIException, IOException, Types.SrOperationNotSupportedString> xenstoreData) Create a new VDI record in the database only Minimum allowed role: vm-admin First published in XenServer 4.1.- Parameters:
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 xenstore- Returns:
- The ref of the newly created VDI record.
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.Types.SrOperationNotSupported
- The SR backend does not support the operation (check the SR's allowed operations)
-
introduce
public static VDI introduce(Connection c, String uuid, String nameLabel, String nameDescription, SR SR, Types.VdiType type, Boolean sharable, Boolean readOnly, Map<String, String> otherConfig, String location, Map<String, throws Types.BadServerResponse, Types.XenAPIException, IOException, Types.SrOperationNotSupportedString> xenstoreData, Map<String, String> smConfig) Create a new VDI record in the database only Minimum allowed role: vm-admin First published in XenServer 4.1.- Parameters:
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 config- Returns:
- The ref of the newly created VDI record.
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.Types.SrOperationNotSupported
- The SR backend does not support the operation (check the SR's allowed operations)
-
introduce
public static VDI introduce(Connection c, String uuid, String nameLabel, String nameDescription, SR SR, Types.VdiType type, Boolean sharable, Boolean readOnly, Map<String, String> otherConfig, String location, Map<String, throws Types.BadServerResponse, Types.XenAPIException, IOException, Types.SrOperationNotSupportedString> xenstoreData, Map<String, String> smConfig, Boolean managed, Long virtualSize, Long physicalUtilisation, Pool metadataOfPool, Boolean isASnapshot, Date snapshotTime, VDI snapshotOf) Create a new VDI record in the database only Minimum allowed role: vm-admin First published in XenServer 4.1.- Parameters:
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. When the timezone is missing, UTC is assumed 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
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.Types.SrOperationNotSupported
- The SR backend does not support the operation (check the SR's allowed operations)
-
introduceAsync
public static Task introduceAsync(Connection c, String uuid, String nameLabel, String nameDescription, SR SR, Types.VdiType type, Boolean sharable, Boolean readOnly, Map<String, String> otherConfig, String location, Map<String, throws Types.BadServerResponse, Types.XenAPIException, IOException, Types.SrOperationNotSupportedString> xenstoreData) Create a new VDI record in the database only Minimum allowed role: vm-admin First published in XenServer 4.1.- Parameters:
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 xenstore- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.Types.SrOperationNotSupported
- The SR backend does not support the operation (check the SR's allowed operations)
-
introduceAsync
public static Task introduceAsync(Connection c, String uuid, String nameLabel, String nameDescription, SR SR, Types.VdiType type, Boolean sharable, Boolean readOnly, Map<String, String> otherConfig, String location, Map<String, throws Types.BadServerResponse, Types.XenAPIException, IOException, Types.SrOperationNotSupportedString> xenstoreData, Map<String, String> smConfig) Create a new VDI record in the database only Minimum allowed role: vm-admin First published in XenServer 4.1.- Parameters:
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 config- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.Types.SrOperationNotSupported
- The SR backend does not support the operation (check the SR's allowed operations)
-
introduceAsync
public static Task introduceAsync(Connection c, String uuid, String nameLabel, String nameDescription, SR SR, Types.VdiType type, Boolean sharable, Boolean readOnly, Map<String, String> otherConfig, String location, Map<String, throws Types.BadServerResponse, Types.XenAPIException, IOException, Types.SrOperationNotSupportedString> xenstoreData, Map<String, String> smConfig, Boolean managed, Long virtualSize, Long physicalUtilisation, Pool metadataOfPool, Boolean isASnapshot, Date snapshotTime, VDI snapshotOf) Create a new VDI record in the database only Minimum allowed role: vm-admin First published in XenServer 4.1.- Parameters:
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. When the timezone is missing, UTC is assumed First published in XenServer 6.1.snapshotOf
- Storage-specific config First published in XenServer 6.1.- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.Types.SrOperationNotSupported
- The SR backend does not support the operation (check the SR's allowed operations)
-
update
public void update(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException, Types.SrOperationNotSupported Ask the storage backend to refresh the fields in the VDI object Minimum allowed role: vm-admin First published in XenServer 4.1.1.- Parameters:
c
- The connection the call is made on- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.Types.SrOperationNotSupported
- The SR backend does not support the operation (check the SR's allowed operations)
-
updateAsync
public Task updateAsync(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException, Types.SrOperationNotSupported Ask the storage backend to refresh the fields in the VDI object Minimum allowed role: vm-admin First published in XenServer 4.1.1.- Parameters:
c
- The connection the call is made on- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.Types.SrOperationNotSupported
- The SR backend does not support the operation (check the SR's allowed operations)
-
copy
public VDI copy(Connection c, SR sr) throws Types.BadServerResponse, Types.XenAPIException, IOException, 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. Minimum allowed role: vm-admin First published in XenServer 4.0.- Parameters:
c
- The connection the call is made onsr
- 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
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.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.
-
copy
public VDI copy(Connection c, SR sr, VDI baseVdi, VDI intoVdi) throws Types.BadServerResponse, Types.XenAPIException, IOException, 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. Minimum allowed role: vm-admin First published in XenServer 4.0.- Parameters:
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.- Returns:
- The reference of the VDI where the blocks were written.
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.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.
-
copyAsync
public Task copyAsync(Connection c, SR sr) throws Types.BadServerResponse, Types.XenAPIException, IOException, 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. Minimum allowed role: vm-admin First published in XenServer 4.0.- Parameters:
c
- The connection the call is made onsr
- The destination SR (only required if the destination VDI is not specified- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.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.
-
copyAsync
public Task copyAsync(Connection c, SR sr, VDI baseVdi, VDI intoVdi) throws Types.BadServerResponse, Types.XenAPIException, IOException, 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. Minimum allowed role: vm-admin First published in XenServer 4.0.- Parameters:
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.- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.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.
-
forget
Removes a VDI record from the database Minimum allowed role: vm-admin First published in XenServer 4.0.- Parameters:
c
- The connection the call is made on- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
forgetAsync
public Task forgetAsync(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Removes a VDI record from the database Minimum allowed role: vm-admin First published in XenServer 4.0.- Parameters:
c
- The connection the call is made on- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
setSharable
public void setSharable(Connection c, Boolean value) throws Types.BadServerResponse, Types.XenAPIException, IOException Sets the VDI's sharable field Minimum allowed role: vm-admin First published in XenServer 5.5.- Parameters:
c
- The connection the call is made onvalue
- The new value of the VDI's sharable field- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
setReadOnly
public void setReadOnly(Connection c, Boolean value) throws Types.BadServerResponse, Types.XenAPIException, IOException Sets the VDI's read_only field Minimum allowed role: vm-admin First published in XenServer 4.0.- Parameters:
c
- The connection the call is made onvalue
- The new value of the VDI's read_only field- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
setNameLabel
public void setNameLabel(Connection c, String value) throws Types.BadServerResponse, Types.XenAPIException, IOException Set the name label of the VDI. This can only happen when then its SR is currently attached. Minimum allowed role: vm-admin First published in XenServer 4.0.- Parameters:
c
- The connection the call is made onvalue
- The name lable for the VDI- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
setNameLabelAsync
public Task setNameLabelAsync(Connection c, String value) throws Types.BadServerResponse, Types.XenAPIException, IOException Set the name label of the VDI. This can only happen when then its SR is currently attached. Minimum allowed role: vm-admin First published in XenServer 4.0.- Parameters:
c
- The connection the call is made onvalue
- The name lable for the VDI- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
setNameDescription
public void setNameDescription(Connection c, String value) throws Types.BadServerResponse, Types.XenAPIException, IOException Set the name description of the VDI. This can only happen when its SR is currently attached. Minimum allowed role: vm-admin First published in XenServer 4.0.- Parameters:
c
- The connection the call is made onvalue
- The name description for the VDI- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
setNameDescriptionAsync
public Task setNameDescriptionAsync(Connection c, String value) throws Types.BadServerResponse, Types.XenAPIException, IOException Set the name description of the VDI. This can only happen when its SR is currently attached. Minimum allowed role: vm-admin First published in XenServer 4.0.- Parameters:
c
- The connection the call is made onvalue
- The name description for the VDI- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
setOnBoot
public void setOnBoot(Connection c, Types.OnBoot value) throws Types.BadServerResponse, Types.XenAPIException, IOException Set the value of the on_boot parameter. This value can only be changed when the VDI is not attached to a running VM. Minimum allowed role: vm-admin First published in XenServer 5.6 FP1.- Parameters:
c
- The connection the call is made onvalue
- The value to set- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
setOnBootAsync
public Task setOnBootAsync(Connection c, Types.OnBoot value) throws Types.BadServerResponse, Types.XenAPIException, IOException Set the value of the on_boot parameter. This value can only be changed when the VDI is not attached to a running VM. Minimum allowed role: vm-admin First published in XenServer 5.6 FP1.- Parameters:
c
- The connection the call is made onvalue
- The value to set- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
setAllowCaching
public void setAllowCaching(Connection c, Boolean value) throws Types.BadServerResponse, Types.XenAPIException, IOException 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. Minimum allowed role: vm-admin First published in XenServer 5.6 FP1.- Parameters:
c
- The connection the call is made onvalue
- The value to set- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
setAllowCachingAsync
public Task setAllowCachingAsync(Connection c, Boolean value) throws Types.BadServerResponse, Types.XenAPIException, IOException 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. Minimum allowed role: vm-admin First published in XenServer 5.6 FP1.- Parameters:
c
- The connection the call is made onvalue
- The value to set- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
openDatabase
public Session openDatabase(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Load the metadata found on the supplied VDI and return a session reference which can be used in API calls to query its contents. Minimum allowed role: pool-operator First published in XenServer 6.0.- Parameters:
c
- The connection the call is made on- Returns:
- A session which can be used to query the database
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
openDatabaseAsync
public Task openDatabaseAsync(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Load the metadata found on the supplied VDI and return a session reference which can be used in API calls to query its contents. Minimum allowed role: pool-operator First published in XenServer 6.0.- Parameters:
c
- The connection the call is made on- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
readDatabasePoolUuid
public String readDatabasePoolUuid(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Check the VDI cache for the pool UUID of the database on this VDI. Minimum allowed role: read-only First published in XenServer 6.0.- Parameters:
c
- The connection the call is made on- Returns:
- The cached pool UUID of the database on the VDI.
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
readDatabasePoolUuidAsync
public Task readDatabasePoolUuidAsync(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Check the VDI cache for the pool UUID of the database on this VDI. Minimum allowed role: read-only First published in XenServer 6.0.- Parameters:
c
- The connection the call is made on- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
poolMigrate
public VDI poolMigrate(Connection c, SR sr, Map<String, String> options) throws Types.BadServerResponse, Types.XenAPIException, IOExceptionMigrate a VDI, which may be attached to a running guest, to a different SR. The destination SR must be visible to the guest. Minimum allowed role: vm-power-admin First published in XenServer 6.1.- Parameters:
c
- The connection the call is made onsr
- The destination SRoptions
- Other parameters- Returns:
- The new reference of the migrated VDI.
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
poolMigrateAsync
public Task poolMigrateAsync(Connection c, SR sr, Map<String, String> options) throws Types.BadServerResponse, Types.XenAPIException, IOExceptionMigrate a VDI, which may be attached to a running guest, to a different SR. The destination SR must be visible to the guest. Minimum allowed role: vm-power-admin First published in XenServer 6.1.- Parameters:
c
- The connection the call is made onsr
- The destination SRoptions
- Other parameters- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
enableCbt
public void enableCbt(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException, 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. Minimum allowed role: vm-admin First published in XenServer 7.3.- Parameters:
c
- The connection the call is made on- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.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.
-
enableCbtAsync
public Task enableCbtAsync(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException, 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. Minimum allowed role: vm-admin First published in XenServer 7.3.- Parameters:
c
- The connection the call is made on- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.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.
-
disableCbt
public void disableCbt(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException, 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. Minimum allowed role: vm-admin First published in XenServer 7.3.- Parameters:
c
- The connection the call is made on- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.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.
-
disableCbtAsync
public Task disableCbtAsync(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException, 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. Minimum allowed role: vm-admin First published in XenServer 7.3.- Parameters:
c
- The connection the call is made on- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.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.
-
dataDestroy
public void dataDestroy(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException, 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. Minimum allowed role: vm-admin First published in XenServer 7.3.- Parameters:
c
- The connection the call is made on- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.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 device
-
dataDestroyAsync
public Task dataDestroyAsync(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException, 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. Minimum allowed role: vm-admin First published in XenServer 7.3.- Parameters:
c
- The connection the call is made on- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.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 device
-
listChangedBlocks
public String listChangedBlocks(Connection c, VDI vdiTo) throws Types.BadServerResponse, Types.XenAPIException, IOException, 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. Minimum allowed role: vm-operator First published in XenServer 7.3.- Parameters:
c
- The connection the call is made onvdiTo
- The second VDI.- Returns:
- A base64 string-encoding of the bitmap showing which blocks differ in the two VDIs.
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.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 operation
-
listChangedBlocksAsync
public Task listChangedBlocksAsync(Connection c, VDI vdiTo) throws Types.BadServerResponse, Types.XenAPIException, IOException, 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. Minimum allowed role: vm-operator First published in XenServer 7.3.- Parameters:
c
- The connection the call is made onvdiTo
- The second VDI.- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.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 operation
-
getNbdInfo
public Set<VdiNbdServerInfo.Record> getNbdInfo(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException, 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. Minimum allowed role: vm-admin First published in XenServer 7.3.- Parameters:
c
- The connection the call is made on- 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
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.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)
-
getAll
public static Set<VDI> getAll(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Return a list of all the VDIs known to the system. Minimum allowed role: read-only First published in XenServer 4.0.- Parameters:
c
- The connection the call is made on- Returns:
- references to all objects
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getAllRecords
public static Map<VDI,VDI.Record> getAllRecords(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Return a map of VDI references to VDI records for all VDIs known to the system. Minimum allowed role: read-only First published in XenServer 4.0.- Parameters:
c
- The connection the call is made on- Returns:
- records of all objects
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-