Package com.xensource.xenapi
Class SR
java.lang.Object
com.xensource.xenapi.XenAPIObject
com.xensource.xenapi.SR
A storage repository
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 SR.void
addToOtherConfig
(Connection c, String key, String value) Add the given key-value pair to the other_config field of the given SR.void
addToSmConfig
(Connection c, String key, String value) Add the given key-value pair to the sm_config field of the given SR.void
Returns successfully if the given SR can host an HA statefile.Returns successfully if the given SR can host an HA statefile.void
Returns successfully if the given SR supports database replication.Returns successfully if the given SR supports database replication.static SR
create
(Connection c, Host host, Map<String, String> deviceConfig, Long physicalSize, String nameLabel, String nameDescription, String type, String contentType, Boolean shared) Create a new Storage Repository and introduce it into the managed system, creating both SR record and PBD record to attach it to current host (with specified device_config parameters) Minimum allowed role: pool-operator First published in XenServer 4.0.static SR
create
(Connection c, Host host, Map<String, String> deviceConfig, Long physicalSize, String nameLabel, String nameDescription, String type, String contentType, Boolean shared, Map<String, String> smConfig) Create a new Storage Repository and introduce it into the managed system, creating both SR record and PBD record to attach it to current host (with specified device_config parameters) Minimum allowed role: pool-operator First published in XenServer 4.0.static Task
createAsync
(Connection c, Host host, Map<String, String> deviceConfig, Long physicalSize, String nameLabel, String nameDescription, String type, String contentType, Boolean shared) Create a new Storage Repository and introduce it into the managed system, creating both SR record and PBD record to attach it to current host (with specified device_config parameters) Minimum allowed role: pool-operator First published in XenServer 4.0.static Task
createAsync
(Connection c, Host host, Map<String, String> deviceConfig, Long physicalSize, String nameLabel, String nameDescription, String type, String contentType, Boolean shared, Map<String, String> smConfig) Create a new Storage Repository and introduce it into the managed system, creating both SR record and PBD record to attach it to current host (with specified device_config parameters) Minimum allowed role: pool-operator First published in XenServer 4.0.createNewBlob
(Connection c, String name, String mimeType) Create a placeholder for a named binary blob of data that is associated with this SR Minimum allowed role: pool-operator First published in XenServer 5.0.createNewBlob
(Connection c, String name, String mimeType, Boolean _public) Create a placeholder for a named binary blob of data that is associated with this SR Minimum allowed role: pool-operator First published in XenServer 5.0.createNewBlobAsync
(Connection c, String name, String mimeType) Create a placeholder for a named binary blob of data that is associated with this SR Minimum allowed role: pool-operator First published in XenServer 5.0.createNewBlobAsync
(Connection c, String name, String mimeType, Boolean _public) Create a placeholder for a named binary blob of data that is associated with this SR Minimum allowed role: pool-operator First published in XenServer 5.0.void
Destroy specified SR, removing SR-record from database and remove SR from disk.Destroy specified SR, removing SR-record from database and remove SR from disk.void
Minimum allowed role: pool-operator First published in XenServer 6.0.Minimum allowed role: pool-operator First published in XenServer 6.0.void
Minimum allowed role: pool-operator First published in XenServer 6.0.Minimum allowed role: pool-operator First published in XenServer 6.0.boolean
If obj is a SR, compares XenAPI references for equality.void
forget
(Connection c) Removing specified SR-record from database, without attempting to remove SR from disk Minimum allowed role: pool-operator First published in XenServer 4.0.Removing specified SR-record from database, without attempting to remove SR from disk Minimum allowed role: pool-operator First published in XenServer 4.0.void
forgetDataSourceArchives
(Connection c, String dataSource) Forget the recorded statistics related to the specified data source Minimum allowed role: pool-operator First published in XenServer 7.0.getAll
(Connection c) Return a list of all the SRs known to the system.Get the allowed_operations field of the given SR.Return a map of SR references to SR records for all SRs known to the system.Get the blobs field of the given SR.getByNameLabel
(Connection c, String label) Get all the SR instances with the given label.static SR
getByUuid
(Connection c, String uuid) Get a reference to the SR instance with the specified UUID.Get the clustered field of the given SR.Get the content_type field of the given SR.Get the current_operations field of the given SR.Minimum allowed role: read-only First published in XenServer 7.0.Get the introduced_by field of the given SR.Get the is_tools_sr field of the given SR.Get the local_cache_enabled field of the given SR.Get the name/description field of the given SR.Get the name/label field of the given SR.Get the other_config field of the given SR.Get the PBDs field of the given SR.Get the physical_size field of the given SR.Get the physical_utilisation field of the given SR.Get a record containing the current state of the given SR.Get the shared field of the given SR.Get the sm_config field of the given SR.Return a set of all the SR types supported by the system Minimum allowed role: read-only First published in XenServer 4.0.Get the tags field of the given SR.Get the type field of the given SR.Get the uuid field of the given SR.Get the VDIs field of the given SR.Get the virtual_allocation field of the given SR.int
hashCode()
static SR
introduce
(Connection c, String uuid, String nameLabel, String nameDescription, String type, String contentType, Boolean shared) Introduce a new Storage Repository into the managed system Minimum allowed role: pool-operator First published in XenServer 4.0.static SR
introduce
(Connection c, String uuid, String nameLabel, String nameDescription, String type, String contentType, Boolean shared, Map<String, String> smConfig) Introduce a new Storage Repository into the managed system Minimum allowed role: pool-operator First published in XenServer 4.0.static Task
introduceAsync
(Connection c, String uuid, String nameLabel, String nameDescription, String type, String contentType, Boolean shared) Introduce a new Storage Repository into the managed system Minimum allowed role: pool-operator First published in XenServer 4.0.static Task
introduceAsync
(Connection c, String uuid, String nameLabel, String nameDescription, String type, String contentType, Boolean shared, Map<String, String> smConfig) Introduce a new Storage Repository into the managed system Minimum allowed role: pool-operator First published in XenServer 4.0.static String
make
(Connection c, Host host, Map<String, String> deviceConfig, Long physicalSize, String nameLabel, String nameDescription, String type, String contentType) Deprecated.static String
make
(Connection c, Host host, Map<String, String> deviceConfig, Long physicalSize, String nameLabel, String nameDescription, String type, String contentType, Map<String, String> smConfig) Deprecated.static Task
makeAsync
(Connection c, Host host, Map<String, String> deviceConfig, Long physicalSize, String nameLabel, String nameDescription, String type, String contentType) Deprecated.static Task
makeAsync
(Connection c, Host host, Map<String, String> deviceConfig, Long physicalSize, String nameLabel, String nameDescription, String type, String contentType, Map<String, String> smConfig) Deprecated.static String
Perform a backend-specific scan, using the given device_config.static String
probe
(Connection c, Host host, Map<String, String> deviceConfig, String type, Map<String, String> smConfig) Perform a backend-specific scan, using the given device_config.static Task
probeAsync
(Connection c, Host host, Map<String, String> deviceConfig) Perform a backend-specific scan, using the given device_config.static Task
probeAsync
(Connection c, Host host, Map<String, String> deviceConfig, String type, Map<String, String> smConfig) Perform a backend-specific scan, using the given device_config.static Set<ProbeResult.Record>
probeExt
(Connection c, Host host, Map<String, String> deviceConfig, String type, Map<String, String> smConfig) Perform a backend-specific scan, using the given device_config.static Task
probeExtAsync
(Connection c, Host host, Map<String, String> deviceConfig, String type, Map<String, String> smConfig) Perform a backend-specific scan, using the given device_config.queryDataSource
(Connection c, String dataSource) Query the latest value of the specified data source Minimum allowed role: read-only First published in XenServer 7.0.void
recordDataSource
(Connection c, String dataSource) Start recording the specified data source Minimum allowed role: pool-operator First published in XenServer 7.0.void
removeFromOtherConfig
(Connection c, String key) Remove the given key and its corresponding value from the other_config field of the given SR.void
removeFromSmConfig
(Connection c, String key) Remove the given key and its corresponding value from the sm_config field of the given SR.void
removeTags
(Connection c, String value) Remove the given value from the tags field of the given SR.void
scan
(Connection c) Refreshes the list of VDIs associated with an SR Minimum allowed role: vm-power-admin First published in XenServer 4.0.Refreshes the list of VDIs associated with an SR Minimum allowed role: vm-power-admin First published in XenServer 4.0.void
setNameDescription
(Connection c, String value) Set the name description of the SR Minimum allowed role: pool-operator First published in XenServer 4.0.setNameDescriptionAsync
(Connection c, String value) Set the name description of the SR Minimum allowed role: pool-operator First published in XenServer 4.0.void
setNameLabel
(Connection c, String value) Set the name label of the SR Minimum allowed role: pool-operator First published in XenServer 4.0.setNameLabelAsync
(Connection c, String value) Set the name label of the SR Minimum allowed role: pool-operator First published in XenServer 4.0.void
setOtherConfig
(Connection c, Map<String, String> otherConfig) Set the other_config field of the given SR.void
setPhysicalSize
(Connection c, Long value) Sets the SR's physical_size field Minimum allowed role: pool-operator First published in XenServer 4.1.void
setShared
(Connection c, Boolean value) Sets the shared flag on the SR Minimum allowed role: pool-operator First published in XenServer 4.0.setSharedAsync
(Connection c, Boolean value) Sets the shared flag on the SR Minimum allowed role: pool-operator First published in XenServer 4.0.void
setSmConfig
(Connection c, Map<String, String> smConfig) Set the sm_config field of the given SR.void
setTags
(Connection c, Set<String> tags) Set the tags field of the given SR.void
update
(Connection c) Refresh the fields on the SR object Minimum allowed role: pool-operator First published in XenServer 4.1.1.Refresh the fields on the SR object Minimum allowed role: pool-operator 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 SR, compares XenAPI references for equality. -
hashCode
public int hashCode() -
getRecord
public SR.Record getRecord(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException Get a record containing the current state of the given SR. 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
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.
-
getByUuid
public static SR getByUuid(Connection c, String uuid) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException Get a reference to the SR 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
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.
-
getByNameLabel
public static Set<SR> getByNameLabel(Connection c, String label) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException Get all the SR 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
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.
-
getUuid
public String getUuid(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException Get the uuid field of the given SR. 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
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.
-
getNameLabel
public String getNameLabel(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException Get the name/label field of the given SR. 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
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.
-
getNameDescription
public String getNameDescription(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException Get the name/description field of the given SR. 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
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.
-
getAllowedOperations
public Set<Types.StorageOperations> getAllowedOperations(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException Get the allowed_operations field of the given SR. 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
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.
-
getCurrentOperations
public Map<String,Types.StorageOperations> getCurrentOperations(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException Get the current_operations field of the given SR. 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
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.
-
getVDIs
public Set<VDI> getVDIs(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException Get the VDIs field of the given SR. 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
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.
-
getPBDs
public Set<PBD> getPBDs(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException Get the PBDs field of the given SR. 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
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.
-
getVirtualAllocation
public Long getVirtualAllocation(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException Get the virtual_allocation field of the given SR. 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
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.
-
getPhysicalUtilisation
public Long getPhysicalUtilisation(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException Get the physical_utilisation field of the given SR. 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
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.
-
getPhysicalSize
public Long getPhysicalSize(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException Get the physical_size field of the given SR. 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
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.
-
getType
public String getType(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException Get the type field of the given SR. 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
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.
-
getContentType
public String getContentType(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException Get the content_type field of the given SR. 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
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.
-
getOtherConfig
public Map<String,String> getOtherConfig(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException Get the other_config field of the given SR. 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
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.
-
getTags
public Set<String> getTags(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException Get the tags field of the given SR. 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
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.
-
getSmConfig
public Map<String,String> getSmConfig(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException Get the sm_config field of the given SR. 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
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.
-
getBlobs
public Map<String,Blob> getBlobs(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException Get the blobs field of the given SR. 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
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.
-
getLocalCacheEnabled
public Boolean getLocalCacheEnabled(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException Get the local_cache_enabled field of the given SR. 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
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.
-
getIntroducedBy
public DRTask getIntroducedBy(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException Get the introduced_by field of the given SR. 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
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.
-
getClustered
public Boolean getClustered(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException Get the clustered field of the given SR. 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
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.
-
getIsToolsSr
public Boolean getIsToolsSr(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException Get the is_tools_sr field of the given SR. 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
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.
-
setOtherConfig
public void setOtherConfig(Connection c, Map<String, String> otherConfig) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcExceptionSet the other_config field of the given SR. Minimum allowed role: pool-operator 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
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.
-
addToOtherConfig
public void addToOtherConfig(Connection c, String key, String value) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException Add the given key-value pair to the other_config field of the given SR. Minimum allowed role: pool-operator 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
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.
-
removeFromOtherConfig
public void removeFromOtherConfig(Connection c, String key) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException Remove the given key and its corresponding value from the other_config field of the given SR. If the key is not in that Map, then do nothing. Minimum allowed role: pool-operator 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
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.
-
setTags
public void setTags(Connection c, Set<String> tags) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException Set the tags field of the given SR. 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
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.
-
addTags
public void addTags(Connection c, String value) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException Add the given value to the tags field of the given SR. 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
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.
-
removeTags
public void removeTags(Connection c, String value) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException Remove the given value from the tags field of the given SR. 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
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.
-
setSmConfig
public void setSmConfig(Connection c, Map<String, String> smConfig) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcExceptionSet the sm_config field of the given SR. Minimum allowed role: pool-operator 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
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.
-
addToSmConfig
public void addToSmConfig(Connection c, String key, String value) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException Add the given key-value pair to the sm_config field of the given SR. Minimum allowed role: pool-operator 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
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.
-
removeFromSmConfig
public void removeFromSmConfig(Connection c, String key) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException Remove the given key and its corresponding value from the sm_config field of the given SR. If the key is not in that Map, then do nothing. Minimum allowed role: pool-operator 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
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.
-
createAsync
public static Task createAsync(Connection c, Host host, Map<String, String> deviceConfig, Long physicalSize, String nameLabel, String nameDescription, String type, String contentType, Boolean shared) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException, Types.SrUnknownDriverCreate a new Storage Repository and introduce it into the managed system, creating both SR record and PBD record to attach it to current host (with specified device_config parameters) Minimum allowed role: pool-operator First published in XenServer 4.0.- Parameters:
c
- The connection the call is made onhost
- The host to create/make the SR ondeviceConfig
- The device config string that will be passed to backend SR driverphysicalSize
- The physical size of the new storage repositorynameLabel
- The name of the new storage repositorynameDescription
- The description of the new storage repositorytype
- The type of the SR; used to specify the SR backend driver to usecontentType
- The type of the new SRs content, if required (e.g. ISOs)shared
- True if the SR (is capable of) being shared by multiple hosts- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.Types.SrUnknownDriver
- The SR could not be connected because the driver was not recognised.
-
create
public static SR create(Connection c, Host host, Map<String, String> deviceConfig, Long physicalSize, String nameLabel, String nameDescription, String type, String contentType, Boolean shared) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException, Types.SrUnknownDriverCreate a new Storage Repository and introduce it into the managed system, creating both SR record and PBD record to attach it to current host (with specified device_config parameters) Minimum allowed role: pool-operator First published in XenServer 4.0.- Parameters:
c
- The connection the call is made onhost
- The host to create/make the SR ondeviceConfig
- The device config string that will be passed to backend SR driverphysicalSize
- The physical size of the new storage repositorynameLabel
- The name of the new storage repositorynameDescription
- The description of the new storage repositorytype
- The type of the SR; used to specify the SR backend driver to usecontentType
- The type of the new SRs content, if required (e.g. ISOs)shared
- True if the SR (is capable of) being shared by multiple hosts- Returns:
- The reference of the newly created Storage Repository.
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.Types.SrUnknownDriver
- The SR could not be connected because the driver was not recognised.
-
createAsync
public static Task createAsync(Connection c, Host host, Map<String, String> deviceConfig, Long physicalSize, String nameLabel, String nameDescription, String type, String contentType, Boolean shared, Map<String, throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException, Types.SrUnknownDriverString> smConfig) Create a new Storage Repository and introduce it into the managed system, creating both SR record and PBD record to attach it to current host (with specified device_config parameters) Minimum allowed role: pool-operator First published in XenServer 4.0.- Parameters:
c
- The connection the call is made onhost
- The host to create/make the SR ondeviceConfig
- The device config string that will be passed to backend SR driverphysicalSize
- The physical size of the new storage repositorynameLabel
- The name of the new storage repositorynameDescription
- The description of the new storage repositorytype
- The type of the SR; used to specify the SR backend driver to usecontentType
- The type of the new SRs content, if required (e.g. ISOs)shared
- True if the SR (is capable of) being shared by multiple hostssmConfig
- Storage backend specific configuration 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
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.Types.SrUnknownDriver
- The SR could not be connected because the driver was not recognised.
-
create
public static SR create(Connection c, Host host, Map<String, String> deviceConfig, Long physicalSize, String nameLabel, String nameDescription, String type, String contentType, Boolean shared, Map<String, throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException, Types.SrUnknownDriverString> smConfig) Create a new Storage Repository and introduce it into the managed system, creating both SR record and PBD record to attach it to current host (with specified device_config parameters) Minimum allowed role: pool-operator First published in XenServer 4.0.- Parameters:
c
- The connection the call is made onhost
- The host to create/make the SR ondeviceConfig
- The device config string that will be passed to backend SR driverphysicalSize
- The physical size of the new storage repositorynameLabel
- The name of the new storage repositorynameDescription
- The description of the new storage repositorytype
- The type of the SR; used to specify the SR backend driver to usecontentType
- The type of the new SRs content, if required (e.g. ISOs)shared
- True if the SR (is capable of) being shared by multiple hostssmConfig
- Storage backend specific configuration options First published in XenServer 4.1.- Returns:
- The reference of the newly created Storage Repository.
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.Types.SrUnknownDriver
- The SR could not be connected because the driver was not recognised.
-
introduceAsync
public static Task introduceAsync(Connection c, String uuid, String nameLabel, String nameDescription, String type, String contentType, Boolean shared) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException Introduce a new Storage Repository into the managed system Minimum allowed role: pool-operator First published in XenServer 4.0.- Parameters:
c
- The connection the call is made onuuid
- The uuid assigned to the introduced SRnameLabel
- The name of the new storage repositorynameDescription
- The description of the new storage repositorytype
- The type of the SR; used to specify the SR backend driver to usecontentType
- The type of the new SRs content, if required (e.g. ISOs)shared
- True if the SR (is capable of) being shared by multiple hosts- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.
-
introduce
public static SR introduce(Connection c, String uuid, String nameLabel, String nameDescription, String type, String contentType, Boolean shared) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException Introduce a new Storage Repository into the managed system Minimum allowed role: pool-operator First published in XenServer 4.0.- Parameters:
c
- The connection the call is made onuuid
- The uuid assigned to the introduced SRnameLabel
- The name of the new storage repositorynameDescription
- The description of the new storage repositorytype
- The type of the SR; used to specify the SR backend driver to usecontentType
- The type of the new SRs content, if required (e.g. ISOs)shared
- True if the SR (is capable of) being shared by multiple hosts- Returns:
- The reference of the newly introduced Storage Repository.
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.
-
introduceAsync
public static Task introduceAsync(Connection c, String uuid, String nameLabel, String nameDescription, String type, String contentType, Boolean shared, Map<String, String> smConfig) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcExceptionIntroduce a new Storage Repository into the managed system Minimum allowed role: pool-operator First published in XenServer 4.0.- Parameters:
c
- The connection the call is made onuuid
- The uuid assigned to the introduced SRnameLabel
- The name of the new storage repositorynameDescription
- The description of the new storage repositorytype
- The type of the SR; used to specify the SR backend driver to usecontentType
- The type of the new SRs content, if required (e.g. ISOs)shared
- True if the SR (is capable of) being shared by multiple hostssmConfig
- Storage backend specific configuration 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
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.
-
introduce
public static SR introduce(Connection c, String uuid, String nameLabel, String nameDescription, String type, String contentType, Boolean shared, Map<String, String> smConfig) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcExceptionIntroduce a new Storage Repository into the managed system Minimum allowed role: pool-operator First published in XenServer 4.0.- Parameters:
c
- The connection the call is made onuuid
- The uuid assigned to the introduced SRnameLabel
- The name of the new storage repositorynameDescription
- The description of the new storage repositorytype
- The type of the SR; used to specify the SR backend driver to usecontentType
- The type of the new SRs content, if required (e.g. ISOs)shared
- True if the SR (is capable of) being shared by multiple hostssmConfig
- Storage backend specific configuration options First published in XenServer 4.1.- Returns:
- The reference of the newly introduced Storage Repository.
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.
-
makeAsync
@Deprecated public static Task makeAsync(Connection c, Host host, Map<String, String> deviceConfig, Long physicalSize, String nameLabel, String nameDescription, String type, String contentType) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcExceptionDeprecated.Create a new Storage Repository on disk. This call is deprecated: use SR.create instead. Minimum allowed role: pool-operator First published in XenServer 4.0.- Parameters:
c
- The connection the call is made onhost
- The host to create/make the SR ondeviceConfig
- The device config string that will be passed to backend SR driverphysicalSize
- The physical size of the new storage repositorynameLabel
- The name of the new storage repositorynameDescription
- The description of the new storage repositorytype
- The type of the SR; used to specify the SR backend driver to usecontentType
- The type of the new SRs content, if required (e.g. ISOs)- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.
-
make
@Deprecated public static String make(Connection c, Host host, Map<String, String> deviceConfig, Long physicalSize, String nameLabel, String nameDescription, String type, String contentType) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcExceptionDeprecated.Create a new Storage Repository on disk. This call is deprecated: use SR.create instead. Minimum allowed role: pool-operator First published in XenServer 4.0.- Parameters:
c
- The connection the call is made onhost
- The host to create/make the SR ondeviceConfig
- The device config string that will be passed to backend SR driverphysicalSize
- The physical size of the new storage repositorynameLabel
- The name of the new storage repositorynameDescription
- The description of the new storage repositorytype
- The type of the SR; used to specify the SR backend driver to usecontentType
- The type of the new SRs content, if required (e.g. ISOs)- Returns:
- The uuid of the newly created Storage Repository.
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.
-
makeAsync
@Deprecated public static Task makeAsync(Connection c, Host host, Map<String, String> deviceConfig, Long physicalSize, String nameLabel, String nameDescription, String type, String contentType, Map<String, throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcExceptionString> smConfig) Deprecated.Create a new Storage Repository on disk. This call is deprecated: use SR.create instead. Minimum allowed role: pool-operator First published in XenServer 4.0.- Parameters:
c
- The connection the call is made onhost
- The host to create/make the SR ondeviceConfig
- The device config string that will be passed to backend SR driverphysicalSize
- The physical size of the new storage repositorynameLabel
- The name of the new storage repositorynameDescription
- The description of the new storage repositorytype
- The type of the SR; used to specify the SR backend driver to usecontentType
- The type of the new SRs content, if required (e.g. ISOs)smConfig
- Storage backend specific configuration 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
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.
-
make
@Deprecated public static String make(Connection c, Host host, Map<String, String> deviceConfig, Long physicalSize, String nameLabel, String nameDescription, String type, String contentType, Map<String, throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcExceptionString> smConfig) Deprecated.Create a new Storage Repository on disk. This call is deprecated: use SR.create instead. Minimum allowed role: pool-operator First published in XenServer 4.0.- Parameters:
c
- The connection the call is made onhost
- The host to create/make the SR ondeviceConfig
- The device config string that will be passed to backend SR driverphysicalSize
- The physical size of the new storage repositorynameLabel
- The name of the new storage repositorynameDescription
- The description of the new storage repositorytype
- The type of the SR; used to specify the SR backend driver to usecontentType
- The type of the new SRs content, if required (e.g. ISOs)smConfig
- Storage backend specific configuration options First published in XenServer 4.1.- Returns:
- The uuid of the newly created Storage Repository.
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.
-
destroyAsync
public Task destroyAsync(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException, Types.SrHasPbd Destroy specified SR, removing SR-record from database and remove SR from disk. (In order to affect this operation the appropriate device_config is read from the specified SR's PBD on current host) Minimum allowed role: pool-operator 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
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.Types.SrHasPbd
- The SR is still connected to a host via a PBD. It cannot be destroyed or forgotten.
-
destroy
public void destroy(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException, Types.SrHasPbd Destroy specified SR, removing SR-record from database and remove SR from disk. (In order to affect this operation the appropriate device_config is read from the specified SR's PBD on current host) Minimum allowed role: pool-operator 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
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.Types.SrHasPbd
- The SR is still connected to a host via a PBD. It cannot be destroyed or forgotten.
-
forgetAsync
public Task forgetAsync(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException, Types.SrHasPbd Removing specified SR-record from database, without attempting to remove SR from disk Minimum allowed role: pool-operator 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
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.Types.SrHasPbd
- The SR is still connected to a host via a PBD. It cannot be destroyed or forgotten.
-
forget
public void forget(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException, Types.SrHasPbd Removing specified SR-record from database, without attempting to remove SR from disk Minimum allowed role: pool-operator 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
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.Types.SrHasPbd
- The SR is still connected to a host via a PBD. It cannot be destroyed or forgotten.
-
updateAsync
public Task updateAsync(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException Refresh the fields on the SR object Minimum allowed role: pool-operator 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
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.
-
update
public void update(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException Refresh the fields on the SR object Minimum allowed role: pool-operator 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
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.
-
getSupportedTypes
public static Set<String> getSupportedTypes(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException Return a set of all the SR types supported by the system Minimum allowed role: read-only First published in XenServer 4.0.- Parameters:
c
- The connection the call is made on- Returns:
- the supported SR types
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.
-
scanAsync
public Task scanAsync(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException Refreshes the list of VDIs associated with an SR Minimum allowed role: vm-power-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
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.
-
scan
public void scan(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException Refreshes the list of VDIs associated with an SR Minimum allowed role: vm-power-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
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.
-
probeAsync
public static Task probeAsync(Connection c, Host host, Map<String, String> deviceConfig) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcExceptionPerform a backend-specific scan, using the given device_config. If the device_config is complete, then this will return a list of the SRs present of this type on the device, if any. If the device_config is partial, then a backend-specific scan will be performed, returning results that will guide the user in improving the device_config. Minimum allowed role: pool-operator First published in XenServer 4.1.- Parameters:
c
- The connection the call is made onhost
- The host to create/make the SR ondeviceConfig
- The device config string that will be passed to backend SR driver- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.
-
probe
public static String probe(Connection c, Host host, Map<String, String> deviceConfig) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcExceptionPerform a backend-specific scan, using the given device_config. If the device_config is complete, then this will return a list of the SRs present of this type on the device, if any. If the device_config is partial, then a backend-specific scan will be performed, returning results that will guide the user in improving the device_config. Minimum allowed role: pool-operator First published in XenServer 4.1.- Parameters:
c
- The connection the call is made onhost
- The host to create/make the SR ondeviceConfig
- The device config string that will be passed to backend SR driver- Returns:
- An XML fragment containing the scan results. These are specific to the scan being performed, and the backend.
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.
-
probeAsync
public static Task probeAsync(Connection c, Host host, Map<String, String> deviceConfig, String type, Map<String, throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcExceptionString> smConfig) Perform a backend-specific scan, using the given device_config. If the device_config is complete, then this will return a list of the SRs present of this type on the device, if any. If the device_config is partial, then a backend-specific scan will be performed, returning results that will guide the user in improving the device_config. Minimum allowed role: pool-operator First published in XenServer 4.1.- Parameters:
c
- The connection the call is made onhost
- The host to create/make the SR ondeviceConfig
- The device config string that will be passed to backend SR drivertype
- The type of the SR; used to specify the SR backend driver to usesmConfig
- Storage backend specific configuration options- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.
-
probe
public static String probe(Connection c, Host host, Map<String, String> deviceConfig, String type, Map<String, throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcExceptionString> smConfig) Perform a backend-specific scan, using the given device_config. If the device_config is complete, then this will return a list of the SRs present of this type on the device, if any. If the device_config is partial, then a backend-specific scan will be performed, returning results that will guide the user in improving the device_config. Minimum allowed role: pool-operator First published in XenServer 4.1.- Parameters:
c
- The connection the call is made onhost
- The host to create/make the SR ondeviceConfig
- The device config string that will be passed to backend SR drivertype
- The type of the SR; used to specify the SR backend driver to usesmConfig
- Storage backend specific configuration options- Returns:
- An XML fragment containing the scan results. These are specific to the scan being performed, and the backend.
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.
-
probeExtAsync
public static Task probeExtAsync(Connection c, Host host, Map<String, String> deviceConfig, String type, Map<String, throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcExceptionString> smConfig) Perform a backend-specific scan, using the given device_config. If the device_config is complete, then this will return a list of the SRs present of this type on the device, if any. If the device_config is partial, then a backend-specific scan will be performed, returning results that will guide the user in improving the device_config. Minimum allowed role: pool-operator First published in XenServer 7.6.- Parameters:
c
- The connection the call is made onhost
- The host to create/make the SR ondeviceConfig
- The device config string that will be passed to backend SR drivertype
- The type of the SR; used to specify the SR backend driver to usesmConfig
- Storage backend specific configuration options- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.
-
probeExt
public static Set<ProbeResult.Record> probeExt(Connection c, Host host, Map<String, String> deviceConfig, String type, Map<String, throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcExceptionString> smConfig) Perform a backend-specific scan, using the given device_config. If the device_config is complete, then this will return a list of the SRs present of this type on the device, if any. If the device_config is partial, then a backend-specific scan will be performed, returning results that will guide the user in improving the device_config. Minimum allowed role: pool-operator First published in XenServer 7.6.- Parameters:
c
- The connection the call is made onhost
- The host to create/make the SR ondeviceConfig
- The device config string that will be passed to backend SR drivertype
- The type of the SR; used to specify the SR backend driver to usesmConfig
- Storage backend specific configuration options- Returns:
- A set of records containing the scan results.
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.
-
setNameLabelAsync
public Task setNameLabelAsync(Connection c, String value) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException Set the name label of the SR Minimum allowed role: pool-operator First published in XenServer 4.0.- Parameters:
c
- The connection the call is made onvalue
- The name label for the SR- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.
-
setNameLabel
public void setNameLabel(Connection c, String value) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException Set the name label of the SR Minimum allowed role: pool-operator First published in XenServer 4.0.- Parameters:
c
- The connection the call is made onvalue
- The name label for the SR- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.
-
setNameDescriptionAsync
public Task setNameDescriptionAsync(Connection c, String value) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException Set the name description of the SR Minimum allowed role: pool-operator First published in XenServer 4.0.- Parameters:
c
- The connection the call is made onvalue
- The name description for the SR- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.
-
setNameDescription
public void setNameDescription(Connection c, String value) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException Set the name description of the SR Minimum allowed role: pool-operator First published in XenServer 4.0.- Parameters:
c
- The connection the call is made onvalue
- The name description for the SR- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.
-
createNewBlobAsync
public Task createNewBlobAsync(Connection c, String name, String mimeType) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException Create a placeholder for a named binary blob of data that is associated with this SR Minimum allowed role: pool-operator First published in XenServer 5.0.- Parameters:
c
- The connection the call is made onname
- The name associated with the blobmimeType
- The mime type for the data. Empty string translates to application/octet-stream- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.
-
createNewBlob
public Blob createNewBlob(Connection c, String name, String mimeType) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException Create a placeholder for a named binary blob of data that is associated with this SR Minimum allowed role: pool-operator First published in XenServer 5.0.- Parameters:
c
- The connection the call is made onname
- The name associated with the blobmimeType
- The mime type for the data. Empty string translates to application/octet-stream- Returns:
- The reference of the blob, needed for populating its data
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.
-
createNewBlobAsync
public Task createNewBlobAsync(Connection c, String name, String mimeType, Boolean _public) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException Create a placeholder for a named binary blob of data that is associated with this SR Minimum allowed role: pool-operator First published in XenServer 5.0.- Parameters:
c
- The connection the call is made onname
- The name associated with the blobmimeType
- The mime type for the data. Empty string translates to application/octet-stream_public
- True if the blob should be publicly available First published in XenServer 6.1.- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.
-
createNewBlob
public Blob createNewBlob(Connection c, String name, String mimeType, Boolean _public) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException Create a placeholder for a named binary blob of data that is associated with this SR Minimum allowed role: pool-operator First published in XenServer 5.0.- Parameters:
c
- The connection the call is made onname
- The name associated with the blobmimeType
- The mime type for the data. Empty string translates to application/octet-stream_public
- True if the blob should be publicly available First published in XenServer 6.1.- Returns:
- The reference of the blob, needed for populating its data
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.
-
setPhysicalSize
public void setPhysicalSize(Connection c, Long value) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException Sets the SR's physical_size field Minimum allowed role: pool-operator First published in XenServer 4.1.- Parameters:
c
- The connection the call is made onvalue
- The new value of the SR's physical_size- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.
-
assertCanHostHaStatefileAsync
public Task assertCanHostHaStatefileAsync(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException Returns successfully if the given SR can host an HA statefile. Otherwise returns an error to explain why not Minimum allowed role: pool-operator First published in XenServer 5.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
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.
-
assertCanHostHaStatefile
public void assertCanHostHaStatefile(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException Returns successfully if the given SR can host an HA statefile. Otherwise returns an error to explain why not Minimum allowed role: pool-operator First published in XenServer 5.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
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.
-
assertSupportsDatabaseReplicationAsync
public Task assertSupportsDatabaseReplicationAsync(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException Returns successfully if the given SR supports database replication. Otherwise returns an error to explain why not. 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
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.
-
assertSupportsDatabaseReplication
public void assertSupportsDatabaseReplication(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException Returns successfully if the given SR supports database replication. Otherwise returns an error to explain why not. Minimum allowed role: pool-operator First published in XenServer 6.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
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.
-
enableDatabaseReplicationAsync
public Task enableDatabaseReplicationAsync(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException 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
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.
-
enableDatabaseReplication
public void enableDatabaseReplication(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException Minimum allowed role: pool-operator First published in XenServer 6.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
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.
-
disableDatabaseReplicationAsync
public Task disableDatabaseReplicationAsync(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException 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
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.
-
disableDatabaseReplication
public void disableDatabaseReplication(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException Minimum allowed role: pool-operator First published in XenServer 6.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
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.
-
getDataSources
public Set<DataSource.Record> getDataSources(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException Minimum allowed role: read-only First published in XenServer 7.0.- Parameters:
c
- The connection the call is made on- Returns:
- A set of data sources
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.
-
recordDataSource
public void recordDataSource(Connection c, String dataSource) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException Start recording the specified data source Minimum allowed role: pool-operator First published in XenServer 7.0.- Parameters:
c
- The connection the call is made ondataSource
- The data source to record- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.
-
queryDataSource
public Double queryDataSource(Connection c, String dataSource) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException Query the latest value of the specified data source Minimum allowed role: read-only First published in XenServer 7.0.- Parameters:
c
- The connection the call is made ondataSource
- The data source to query- Returns:
- The latest value, averaged over the last 5 seconds
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.
-
forgetDataSourceArchives
public void forgetDataSourceArchives(Connection c, String dataSource) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException Forget the recorded statistics related to the specified data source Minimum allowed role: pool-operator First published in XenServer 7.0.- Parameters:
c
- The connection the call is made ondataSource
- The data source whose archives are to be forgotten- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.
-
getAll
public static Set<SR> getAll(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException Return a list of all the SRs 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
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.
-
getAllRecords
public static Map<SR,SR.Record> getAllRecords(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException Return a map of SR references to SR records for all SRs 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
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.
-