com.xensource.xenapi

Class SR

java.lang.Object

com.xensource.xenapi.XenAPIObject

com.xensource.xenapi.SR

public class SR
extends XenAPIObject

A storage repository First published in XenServer 4.0.

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

Method Summary

Methods

Modifier and Type	Method and Description
void	addTags(Connection c, java.lang.String value) Add the given value to the tags field of the given SR.
void	addToOtherConfig(Connection c, java.lang.String key, java.lang.String value) Add the given key-value pair to the other_config field of the given SR.
void	addToSmConfig(Connection c, java.lang.String key, java.lang.String value) Add the given key-value pair to the sm_config field of the given SR.
void	assertCanHostHaStatefile(Connection c) Returns successfully if the given SR can host an HA statefile.
Task	assertCanHostHaStatefileAsync(Connection c) Returns successfully if the given SR can host an HA statefile.
void	assertSupportsDatabaseReplication(Connection c) Returns successfully if the given SR supports database replication.
Task	assertSupportsDatabaseReplicationAsync(Connection c) Returns successfully if the given SR supports database replication.
static SR	create(Connection c, Host host, java.util.Map<java.lang.String,java.lang.String> deviceConfig, java.lang.Long physicalSize, java.lang.String nameLabel, java.lang.String nameDescription, java.lang.String type, java.lang.String contentType, java.lang.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) First published in XenServer 4.0.
static SR	create(Connection c, Host host, java.util.Map<java.lang.String,java.lang.String> deviceConfig, java.lang.Long physicalSize, java.lang.String nameLabel, java.lang.String nameDescription, java.lang.String type, java.lang.String contentType, java.lang.Boolean shared, java.util.Map<java.lang.String,java.lang.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) First published in XenServer 4.0.
static Task	createAsync(Connection c, Host host, java.util.Map<java.lang.String,java.lang.String> deviceConfig, java.lang.Long physicalSize, java.lang.String nameLabel, java.lang.String nameDescription, java.lang.String type, java.lang.String contentType, java.lang.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) First published in XenServer 4.0.
static Task	createAsync(Connection c, Host host, java.util.Map<java.lang.String,java.lang.String> deviceConfig, java.lang.Long physicalSize, java.lang.String nameLabel, java.lang.String nameDescription, java.lang.String type, java.lang.String contentType, java.lang.Boolean shared, java.util.Map<java.lang.String,java.lang.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) First published in XenServer 4.0.
Blob	createNewBlob(Connection c, java.lang.String name, java.lang.String mimeType) Create a placeholder for a named binary blob of data that is associated with this SR First published in XenServer 5.0.
Blob	createNewBlob(Connection c, java.lang.String name, java.lang.String mimeType, java.lang.Boolean _public) Create a placeholder for a named binary blob of data that is associated with this SR First published in XenServer 5.0.
Task	createNewBlobAsync(Connection c, java.lang.String name, java.lang.String mimeType) Create a placeholder for a named binary blob of data that is associated with this SR First published in XenServer 5.0.
Task	createNewBlobAsync(Connection c, java.lang.String name, java.lang.String mimeType, java.lang.Boolean _public) Create a placeholder for a named binary blob of data that is associated with this SR First published in XenServer 5.0.
void	destroy(Connection c) Destroy specified SR, removing SR-record from database and remove SR from disk.
Task	destroyAsync(Connection c) Destroy specified SR, removing SR-record from database and remove SR from disk.
void	disableDatabaseReplication(Connection c) First published in XenServer 6.0.
Task	disableDatabaseReplicationAsync(Connection c) First published in XenServer 6.0.
void	enableDatabaseReplication(Connection c) First published in XenServer 6.0.
Task	enableDatabaseReplicationAsync(Connection c) First published in XenServer 6.0.
boolean	equals(java.lang.Object obj) 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 First published in XenServer 4.0.
Task	forgetAsync(Connection c) Removing specified SR-record from database, without attempting to remove SR from disk First published in XenServer 4.0.
void	forgetDataSourceArchives(Connection c, java.lang.String dataSource) Forget the recorded statistics related to the specified data source First published in XenServer 7.0.
static java.util.Set<SR>	getAll(Connection c) Return a list of all the SRs known to the system.
java.util.Set<Types.StorageOperations>	getAllowedOperations(Connection c) Get the allowed_operations field of the given SR.
static java.util.Map<SR,SR.Record>	getAllRecords(Connection c) Return a map of SR references to SR records for all SRs known to the system.
java.util.Map<java.lang.String,Blob>	getBlobs(Connection c) Get the blobs field of the given SR.
static java.util.Set<SR>	getByNameLabel(Connection c, java.lang.String label) Get all the SR instances with the given label.
static SR	getByUuid(Connection c, java.lang.String uuid) Get a reference to the SR instance with the specified UUID.
java.lang.Boolean	getClustered(Connection c) Get the clustered field of the given SR.
java.lang.String	getContentType(Connection c) Get the content_type field of the given SR.
java.util.Map<java.lang.String,Types.StorageOperations>	getCurrentOperations(Connection c) Get the current_operations field of the given SR.
java.util.Set<DataSource.Record>	getDataSources(Connection c) First published in XenServer 7.0.
DRTask	getIntroducedBy(Connection c) Get the introduced_by field of the given SR.
java.lang.Boolean	getIsToolsSr(Connection c) Get the is_tools_sr field of the given SR.
java.lang.Boolean	getLocalCacheEnabled(Connection c) Get the local_cache_enabled field of the given SR.
java.lang.String	getNameDescription(Connection c) Get the name/description field of the given SR.
java.lang.String	getNameLabel(Connection c) Get the name/label field of the given SR.
java.util.Map<java.lang.String,java.lang.String>	getOtherConfig(Connection c) Get the other_config field of the given SR.
java.util.Set<PBD>	getPBDs(Connection c) Get the PBDs field of the given SR.
java.lang.Long	getPhysicalSize(Connection c) Get the physical_size field of the given SR.
java.lang.Long	getPhysicalUtilisation(Connection c) Get the physical_utilisation field of the given SR.
SR.Record	getRecord(Connection c) Get a record containing the current state of the given SR.
java.lang.Boolean	getShared(Connection c) Get the shared field of the given SR.
java.util.Map<java.lang.String,java.lang.String>	getSmConfig(Connection c) Get the sm_config field of the given SR.
static java.util.Set<java.lang.String>	getSupportedTypes(Connection c) Return a set of all the SR types supported by the system First published in XenServer 4.0.
java.util.Set<java.lang.String>	getTags(Connection c) Get the tags field of the given SR.
java.lang.String	getType(Connection c) Get the type field of the given SR.
java.lang.String	getUuid(Connection c) Get the uuid field of the given SR.
java.util.Set<VDI>	getVDIs(Connection c) Get the VDIs field of the given SR.
java.lang.Long	getVirtualAllocation(Connection c) Get the virtual_allocation field of the given SR.
int	hashCode()
static SR	introduce(Connection c, java.lang.String uuid, java.lang.String nameLabel, java.lang.String nameDescription, java.lang.String type, java.lang.String contentType, java.lang.Boolean shared) Introduce a new Storage Repository into the managed system First published in XenServer 4.0.
static SR	introduce(Connection c, java.lang.String uuid, java.lang.String nameLabel, java.lang.String nameDescription, java.lang.String type, java.lang.String contentType, java.lang.Boolean shared, java.util.Map<java.lang.String,java.lang.String> smConfig) Introduce a new Storage Repository into the managed system First published in XenServer 4.0.
static Task	introduceAsync(Connection c, java.lang.String uuid, java.lang.String nameLabel, java.lang.String nameDescription, java.lang.String type, java.lang.String contentType, java.lang.Boolean shared) Introduce a new Storage Repository into the managed system First published in XenServer 4.0.
static Task	introduceAsync(Connection c, java.lang.String uuid, java.lang.String nameLabel, java.lang.String nameDescription, java.lang.String type, java.lang.String contentType, java.lang.Boolean shared, java.util.Map<java.lang.String,java.lang.String> smConfig) Introduce a new Storage Repository into the managed system First published in XenServer 4.0.
static java.lang.String	make(Connection c, Host host, java.util.Map<java.lang.String,java.lang.String> deviceConfig, java.lang.Long physicalSize, java.lang.String nameLabel, java.lang.String nameDescription, java.lang.String type, java.lang.String contentType) Deprecated.
static java.lang.String	make(Connection c, Host host, java.util.Map<java.lang.String,java.lang.String> deviceConfig, java.lang.Long physicalSize, java.lang.String nameLabel, java.lang.String nameDescription, java.lang.String type, java.lang.String contentType, java.util.Map<java.lang.String,java.lang.String> smConfig) Deprecated.
static Task	makeAsync(Connection c, Host host, java.util.Map<java.lang.String,java.lang.String> deviceConfig, java.lang.Long physicalSize, java.lang.String nameLabel, java.lang.String nameDescription, java.lang.String type, java.lang.String contentType) Deprecated.
static Task	makeAsync(Connection c, Host host, java.util.Map<java.lang.String,java.lang.String> deviceConfig, java.lang.Long physicalSize, java.lang.String nameLabel, java.lang.String nameDescription, java.lang.String type, java.lang.String contentType, java.util.Map<java.lang.String,java.lang.String> smConfig) Deprecated.
static java.lang.String	probe(Connection c, Host host, java.util.Map<java.lang.String,java.lang.String> deviceConfig, java.lang.String type, java.util.Map<java.lang.String,java.lang.String> smConfig) Perform a backend-specific scan, using the given device_config.
static Task	probeAsync(Connection c, Host host, java.util.Map<java.lang.String,java.lang.String> deviceConfig, java.lang.String type, java.util.Map<java.lang.String,java.lang.String> smConfig) Perform a backend-specific scan, using the given device_config.
static java.util.Set<ProbeResult.Record>	probeExt(Connection c, Host host, java.util.Map<java.lang.String,java.lang.String> deviceConfig, java.lang.String type, java.util.Map<java.lang.String,java.lang.String> smConfig) Perform a backend-specific scan, using the given device_config.
static Task	probeExtAsync(Connection c, Host host, java.util.Map<java.lang.String,java.lang.String> deviceConfig, java.lang.String type, java.util.Map<java.lang.String,java.lang.String> smConfig) Perform a backend-specific scan, using the given device_config.
java.lang.Double	queryDataSource(Connection c, java.lang.String dataSource) Query the latest value of the specified data source First published in XenServer 7.0.
void	recordDataSource(Connection c, java.lang.String dataSource) Start recording the specified data source First published in XenServer 7.0.
void	removeFromOtherConfig(Connection c, java.lang.String key) Remove the given key and its corresponding value from the other_config field of the given SR.
void	removeFromSmConfig(Connection c, java.lang.String key) Remove the given key and its corresponding value from the sm_config field of the given SR.
void	removeTags(Connection c, java.lang.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 First published in XenServer 4.0.
Task	scanAsync(Connection c) Refreshes the list of VDIs associated with an SR First published in XenServer 4.0.
void	setNameDescription(Connection c, java.lang.String value) Set the name description of the SR First published in XenServer 4.0.
Task	setNameDescriptionAsync(Connection c, java.lang.String value) Set the name description of the SR First published in XenServer 4.0.
void	setNameLabel(Connection c, java.lang.String value) Set the name label of the SR First published in XenServer 4.0.
Task	setNameLabelAsync(Connection c, java.lang.String value) Set the name label of the SR First published in XenServer 4.0.
void	setOtherConfig(Connection c, java.util.Map<java.lang.String,java.lang.String> otherConfig) Set the other_config field of the given SR.
void	setPhysicalSize(Connection c, java.lang.Long value) Sets the SR's physical_size field First published in XenServer 4.1.
void	setShared(Connection c, java.lang.Boolean value) Sets the shared flag on the SR First published in XenServer 4.0.
Task	setSharedAsync(Connection c, java.lang.Boolean value) Sets the shared flag on the SR First published in XenServer 4.0.
void	setSmConfig(Connection c, java.util.Map<java.lang.String,java.lang.String> smConfig) Set the sm_config field of the given SR.
void	setTags(Connection c, java.util.Set<java.lang.String> tags) Set the tags field of the given SR.
java.lang.String	toWireString()
void	update(Connection c) Refresh the fields on the SR object First published in XenServer 4.1.1.
Task	updateAsync(Connection c) Refresh the fields on the SR object First published in XenServer 4.1.1.

Methods inherited from class com.xensource.xenapi.XenAPIObject

isNull

Methods inherited from class java.lang.Object

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

Field Detail

ref

protected final java.lang.String ref

The XenAPI reference (OpaqueRef) to this object.

Method Detail

toWireString

public java.lang.String toWireString()

Specified by:

toWireString in class XenAPIObject

Returns:

The XenAPI reference (OpaqueRef) to this object.

equals

public boolean equals(java.lang.Object obj)

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

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

getRecord

public 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. First published in XenServer 4.0.

Returns:

all fields from the object

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getByUuid

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

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

Parameters:

uuid - UUID of object to return

Returns:

reference to the object

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getByNameLabel

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

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

Parameters:

label - label of object to return

Returns:

references to objects with matching names

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getUuid

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

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

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getNameLabel

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

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

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getNameDescription

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

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

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getAllowedOperations

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

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

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getCurrentOperations

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

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

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getVDIs

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

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

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getPBDs

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

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

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getVirtualAllocation

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

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

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getPhysicalUtilisation

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

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

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getPhysicalSize

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

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

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getType

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

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

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getContentType

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

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

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getShared

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

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

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getOtherConfig

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

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

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getTags

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

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

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getSmConfig

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

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

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getBlobs

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

Get the blobs field of the given SR. First published in XenServer 5.0.

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getLocalCacheEnabled

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

Get the local_cache_enabled field of the given SR. First published in XenServer 5.6 FP1.

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getIntroducedBy

public DRTask getIntroducedBy(Connection c)
                       throws Types.BadServerResponse,
                              Types.XenAPIException,
                              org.apache.xmlrpc.XmlRpcException

Get the introduced_by field of the given SR. First published in XenServer 6.0.

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getClustered

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

Get the clustered field of the given SR. First published in XenServer 7.0.

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getIsToolsSr

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

Get the is_tools_sr field of the given SR. First published in XenServer 7.0.

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

setOtherConfig

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

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

Parameters:

otherConfig - New value to set

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

addToOtherConfig

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

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

Parameters:

key - Key to add

value - Value to add

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

removeFromOtherConfig

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

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

Parameters:

key - Key to remove

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

setTags

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

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

Parameters:

tags - New value to set

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

addTags

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

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

Parameters:

value - New value to add

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

removeTags

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

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

Parameters:

value - Value to remove

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

setSmConfig

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

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

Parameters:

smConfig - New value to set

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

addToSmConfig

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

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

Parameters:

key - Key to add

value - Value to add

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

removeFromSmConfig

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

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

Parameters:

key - Key to remove

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

createAsync

public static Task createAsync(Connection c,
               Host host,
               java.util.Map<java.lang.String,java.lang.String> deviceConfig,
               java.lang.Long physicalSize,
               java.lang.String nameLabel,
               java.lang.String nameDescription,
               java.lang.String type,
               java.lang.String contentType,
               java.lang.Boolean shared)
                        throws Types.BadServerResponse,
                               Types.XenAPIException,
                               org.apache.xmlrpc.XmlRpcException,
                               Types.SrUnknownDriver

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) First published in XenServer 4.0.

Parameters:

host - The host to create/make the SR on

deviceConfig - The device config string that will be passed to backend SR driver

physicalSize - The physical size of the new storage repository

nameLabel - The name of the new storage repository

nameDescription - The description of the new storage repository

type - The type of the SR; used to specify the SR backend driver to use

contentType - 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

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

Types.SrUnknownDriver

create

public static SR create(Connection c,
        Host host,
        java.util.Map<java.lang.String,java.lang.String> deviceConfig,
        java.lang.Long physicalSize,
        java.lang.String nameLabel,
        java.lang.String nameDescription,
        java.lang.String type,
        java.lang.String contentType,
        java.lang.Boolean shared)
                 throws Types.BadServerResponse,
                        Types.XenAPIException,
                        org.apache.xmlrpc.XmlRpcException,
                        Types.SrUnknownDriver

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) First published in XenServer 4.0.

Parameters:

host - The host to create/make the SR on

deviceConfig - The device config string that will be passed to backend SR driver

physicalSize - The physical size of the new storage repository

nameLabel - The name of the new storage repository

nameDescription - The description of the new storage repository

type - The type of the SR; used to specify the SR backend driver to use

contentType - 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

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

Types.SrUnknownDriver

createAsync

public static Task createAsync(Connection c,
               Host host,
               java.util.Map<java.lang.String,java.lang.String> deviceConfig,
               java.lang.Long physicalSize,
               java.lang.String nameLabel,
               java.lang.String nameDescription,
               java.lang.String type,
               java.lang.String contentType,
               java.lang.Boolean shared,
               java.util.Map<java.lang.String,java.lang.String> smConfig)
                        throws Types.BadServerResponse,
                               Types.XenAPIException,
                               org.apache.xmlrpc.XmlRpcException,
                               Types.SrUnknownDriver

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) First published in XenServer 4.0.

Parameters:

host - The host to create/make the SR on

deviceConfig - The device config string that will be passed to backend SR driver

physicalSize - The physical size of the new storage repository

nameLabel - The name of the new storage repository

nameDescription - The description of the new storage repository

type - The type of the SR; used to specify the SR backend driver to use

contentType - 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

smConfig - Storage backend specific configuration options First published in XenServer 4.1.

Returns:

Task

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

Types.SrUnknownDriver

create

public static SR create(Connection c,
        Host host,
        java.util.Map<java.lang.String,java.lang.String> deviceConfig,
        java.lang.Long physicalSize,
        java.lang.String nameLabel,
        java.lang.String nameDescription,
        java.lang.String type,
        java.lang.String contentType,
        java.lang.Boolean shared,
        java.util.Map<java.lang.String,java.lang.String> smConfig)
                 throws Types.BadServerResponse,
                        Types.XenAPIException,
                        org.apache.xmlrpc.XmlRpcException,
                        Types.SrUnknownDriver

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) First published in XenServer 4.0.

Parameters:

host - The host to create/make the SR on

deviceConfig - The device config string that will be passed to backend SR driver

physicalSize - The physical size of the new storage repository

nameLabel - The name of the new storage repository

nameDescription - The description of the new storage repository

type - The type of the SR; used to specify the SR backend driver to use

contentType - 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

smConfig - Storage backend specific configuration options First published in XenServer 4.1.

Returns:

The reference of the newly created Storage Repository.

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

Types.SrUnknownDriver

introduceAsync

public static Task introduceAsync(Connection c,
                  java.lang.String uuid,
                  java.lang.String nameLabel,
                  java.lang.String nameDescription,
                  java.lang.String type,
                  java.lang.String contentType,
                  java.lang.Boolean shared)
                           throws Types.BadServerResponse,
                                  Types.XenAPIException,
                                  org.apache.xmlrpc.XmlRpcException

Introduce a new Storage Repository into the managed system First published in XenServer 4.0.

Parameters:

uuid - The uuid assigned to the introduced SR

nameLabel - The name of the new storage repository

nameDescription - The description of the new storage repository

type - The type of the SR; used to specify the SR backend driver to use

contentType - 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

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

introduce

public static SR introduce(Connection c,
           java.lang.String uuid,
           java.lang.String nameLabel,
           java.lang.String nameDescription,
           java.lang.String type,
           java.lang.String contentType,
           java.lang.Boolean shared)
                    throws Types.BadServerResponse,
                           Types.XenAPIException,
                           org.apache.xmlrpc.XmlRpcException

Introduce a new Storage Repository into the managed system First published in XenServer 4.0.

Parameters:

uuid - The uuid assigned to the introduced SR

nameLabel - The name of the new storage repository

nameDescription - The description of the new storage repository

type - The type of the SR; used to specify the SR backend driver to use

contentType - 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

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

introduceAsync

public static Task introduceAsync(Connection c,
                  java.lang.String uuid,
                  java.lang.String nameLabel,
                  java.lang.String nameDescription,
                  java.lang.String type,
                  java.lang.String contentType,
                  java.lang.Boolean shared,
                  java.util.Map<java.lang.String,java.lang.String> smConfig)
                           throws Types.BadServerResponse,
                                  Types.XenAPIException,
                                  org.apache.xmlrpc.XmlRpcException

Introduce a new Storage Repository into the managed system First published in XenServer 4.0.

Parameters:

uuid - The uuid assigned to the introduced SR

nameLabel - The name of the new storage repository

nameDescription - The description of the new storage repository

type - The type of the SR; used to specify the SR backend driver to use

contentType - 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

smConfig - Storage backend specific configuration options First published in XenServer 4.1.

Returns:

Task

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

introduce

public static SR introduce(Connection c,
           java.lang.String uuid,
           java.lang.String nameLabel,
           java.lang.String nameDescription,
           java.lang.String type,
           java.lang.String contentType,
           java.lang.Boolean shared,
           java.util.Map<java.lang.String,java.lang.String> smConfig)
                    throws Types.BadServerResponse,
                           Types.XenAPIException,
                           org.apache.xmlrpc.XmlRpcException

Introduce a new Storage Repository into the managed system First published in XenServer 4.0.

Parameters:

uuid - The uuid assigned to the introduced SR

nameLabel - The name of the new storage repository

nameDescription - The description of the new storage repository

type - The type of the SR; used to specify the SR backend driver to use

contentType - 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

smConfig - Storage backend specific configuration options First published in XenServer 4.1.

Returns:

The reference of the newly introduced Storage Repository.

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

makeAsync

@Deprecated
public static Task makeAsync(Connection c,
                        Host host,
                        java.util.Map<java.lang.String,java.lang.String> deviceConfig,
                        java.lang.Long physicalSize,
                        java.lang.String nameLabel,
                        java.lang.String nameDescription,
                        java.lang.String type,
                        java.lang.String contentType)
                      throws Types.BadServerResponse,
                             Types.XenAPIException,
                             org.apache.xmlrpc.XmlRpcException

Deprecated.

Create a new Storage Repository on disk. This call is deprecated: use SR.create instead. First published in XenServer 4.0.

Parameters:

host - The host to create/make the SR on

deviceConfig - The device config string that will be passed to backend SR driver

physicalSize - The physical size of the new storage repository

nameLabel - The name of the new storage repository

nameDescription - The description of the new storage repository

type - The type of the SR; used to specify the SR backend driver to use

contentType - The type of the new SRs content, if required (e.g. ISOs)

Returns:

Task

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

make

@Deprecated
public static java.lang.String make(Connection c,
                               Host host,
                               java.util.Map<java.lang.String,java.lang.String> deviceConfig,
                               java.lang.Long physicalSize,
                               java.lang.String nameLabel,
                               java.lang.String nameDescription,
                               java.lang.String type,
                               java.lang.String contentType)
                             throws Types.BadServerResponse,
                                    Types.XenAPIException,
                                    org.apache.xmlrpc.XmlRpcException

Deprecated.

Create a new Storage Repository on disk. This call is deprecated: use SR.create instead. First published in XenServer 4.0.

Parameters:

host - The host to create/make the SR on

deviceConfig - The device config string that will be passed to backend SR driver

physicalSize - The physical size of the new storage repository

nameLabel - The name of the new storage repository

nameDescription - The description of the new storage repository

type - The type of the SR; used to specify the SR backend driver to use

contentType - The type of the new SRs content, if required (e.g. ISOs)

Returns:

The uuid of the newly created Storage Repository.

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

makeAsync

@Deprecated
public static Task makeAsync(Connection c,
                        Host host,
                        java.util.Map<java.lang.String,java.lang.String> deviceConfig,
                        java.lang.Long physicalSize,
                        java.lang.String nameLabel,
                        java.lang.String nameDescription,
                        java.lang.String type,
                        java.lang.String contentType,
                        java.util.Map<java.lang.String,java.lang.String> smConfig)
                      throws Types.BadServerResponse,
                             Types.XenAPIException,
                             org.apache.xmlrpc.XmlRpcException

Deprecated.

Create a new Storage Repository on disk. This call is deprecated: use SR.create instead. First published in XenServer 4.0.

Parameters:

host - The host to create/make the SR on

deviceConfig - The device config string that will be passed to backend SR driver

physicalSize - The physical size of the new storage repository

nameLabel - The name of the new storage repository

nameDescription - The description of the new storage repository

type - The type of the SR; used to specify the SR backend driver to use

contentType - 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

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

make

@Deprecated
public static java.lang.String make(Connection c,
                               Host host,
                               java.util.Map<java.lang.String,java.lang.String> deviceConfig,
                               java.lang.Long physicalSize,
                               java.lang.String nameLabel,
                               java.lang.String nameDescription,
                               java.lang.String type,
                               java.lang.String contentType,
                               java.util.Map<java.lang.String,java.lang.String> smConfig)
                             throws Types.BadServerResponse,
                                    Types.XenAPIException,
                                    org.apache.xmlrpc.XmlRpcException

Deprecated.

Create a new Storage Repository on disk. This call is deprecated: use SR.create instead. First published in XenServer 4.0.

Parameters:

host - The host to create/make the SR on

deviceConfig - The device config string that will be passed to backend SR driver

physicalSize - The physical size of the new storage repository

nameLabel - The name of the new storage repository

nameDescription - The description of the new storage repository

type - The type of the SR; used to specify the SR backend driver to use

contentType - 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

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

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) First published in XenServer 4.0.

Returns:

Task

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

Types.SrHasPbd

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) First published in XenServer 4.0.

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

Types.SrHasPbd

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 First published in XenServer 4.0.

Returns:

Task

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

Types.SrHasPbd

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 First published in XenServer 4.0.

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

Types.SrHasPbd

updateAsync

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

Refresh the fields on the SR object First published in XenServer 4.1.1.

Returns:

Task

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

update

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

Refresh the fields on the SR object First published in XenServer 4.1.1.

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getSupportedTypes

public static java.util.Set<java.lang.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 First published in XenServer 4.0.

Returns:

the supported SR types

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

scanAsync

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

Refreshes the list of VDIs associated with an SR First published in XenServer 4.0.

Returns:

Task

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

scan

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

Refreshes the list of VDIs associated with an SR First published in XenServer 4.0.

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

probeAsync

public static Task probeAsync(Connection c,
              Host host,
              java.util.Map<java.lang.String,java.lang.String> deviceConfig,
              java.lang.String type,
              java.util.Map<java.lang.String,java.lang.String> smConfig)
                       throws Types.BadServerResponse,
                              Types.XenAPIException,
                              org.apache.xmlrpc.XmlRpcException

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. First published in XenServer 4.1.

Parameters:

host - The host to create/make the SR on

deviceConfig - The device config string that will be passed to backend SR driver

type - The type of the SR; used to specify the SR backend driver to use

smConfig - Storage backend specific configuration options

Returns:

Task

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

probe

public static java.lang.String probe(Connection c,
                     Host host,
                     java.util.Map<java.lang.String,java.lang.String> deviceConfig,
                     java.lang.String type,
                     java.util.Map<java.lang.String,java.lang.String> smConfig)
                              throws Types.BadServerResponse,
                                     Types.XenAPIException,
                                     org.apache.xmlrpc.XmlRpcException

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. First published in XenServer 4.1.

Parameters:

host - The host to create/make the SR on

deviceConfig - The device config string that will be passed to backend SR driver

type - The type of the SR; used to specify the SR backend driver to use

smConfig - 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

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

probeExtAsync

public static Task probeExtAsync(Connection c,
                 Host host,
                 java.util.Map<java.lang.String,java.lang.String> deviceConfig,
                 java.lang.String type,
                 java.util.Map<java.lang.String,java.lang.String> smConfig)
                          throws Types.BadServerResponse,
                                 Types.XenAPIException,
                                 org.apache.xmlrpc.XmlRpcException

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. Experimental. First published in XenServer 7.5.

Parameters:

host - The host to create/make the SR on

deviceConfig - The device config string that will be passed to backend SR driver

type - The type of the SR; used to specify the SR backend driver to use

smConfig - Storage backend specific configuration options

Returns:

Task

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

probeExt

public static java.util.Set<ProbeResult.Record> probeExt(Connection c,
                                         Host host,
                                         java.util.Map<java.lang.String,java.lang.String> deviceConfig,
                                         java.lang.String type,
                                         java.util.Map<java.lang.String,java.lang.String> smConfig)
                                                  throws Types.BadServerResponse,
                                                         Types.XenAPIException,
                                                         org.apache.xmlrpc.XmlRpcException

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. Experimental. First published in XenServer 7.5.

Parameters:

host - The host to create/make the SR on

deviceConfig - The device config string that will be passed to backend SR driver

type - The type of the SR; used to specify the SR backend driver to use

smConfig - Storage backend specific configuration options

Returns:

A set of records containing the scan results.

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

setSharedAsync

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

Sets the shared flag on the SR First published in XenServer 4.0.

Parameters:

value - True if the SR is shared

Returns:

Task

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

setShared

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

Sets the shared flag on the SR First published in XenServer 4.0.

Parameters:

value - True if the SR is shared

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

setNameLabelAsync

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

Set the name label of the SR First published in XenServer 4.0.

Parameters:

value - The name label for the SR

Returns:

Task

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

setNameLabel

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

Set the name label of the SR First published in XenServer 4.0.

Parameters:

value - The name label for the SR

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

setNameDescriptionAsync

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

Set the name description of the SR First published in XenServer 4.0.

Parameters:

value - The name description for the SR

Returns:

Task

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

setNameDescription

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

Set the name description of the SR First published in XenServer 4.0.

Parameters:

value - The name description for the SR

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

createNewBlobAsync

public Task createNewBlobAsync(Connection c,
                      java.lang.String name,
                      java.lang.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 First published in XenServer 5.0.

Parameters:

name - The name associated with the blob

mimeType - The mime type for the data. Empty string translates to application/octet-stream

Returns:

Task

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

createNewBlob

public Blob createNewBlob(Connection c,
                 java.lang.String name,
                 java.lang.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 First published in XenServer 5.0.

Parameters:

name - The name associated with the blob

mimeType - 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

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

createNewBlobAsync

public Task createNewBlobAsync(Connection c,
                      java.lang.String name,
                      java.lang.String mimeType,
                      java.lang.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 First published in XenServer 5.0.

Parameters:

name - The name associated with the blob

mimeType - 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

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

createNewBlob

public Blob createNewBlob(Connection c,
                 java.lang.String name,
                 java.lang.String mimeType,
                 java.lang.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 First published in XenServer 5.0.

Parameters:

name - The name associated with the blob

mimeType - 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

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

setPhysicalSize

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

Sets the SR's physical_size field First published in XenServer 4.1.

Parameters:

value - The new value of the SR's physical_size

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

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 First published in XenServer 5.0.

Returns:

Task

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

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 First published in XenServer 5.0.

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

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. First published in XenServer 6.0.

Returns:

Task

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

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. First published in XenServer 6.0.

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

enableDatabaseReplicationAsync

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

First published in XenServer 6.0.

Returns:

Task

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

enableDatabaseReplication

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

First published in XenServer 6.0.

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

disableDatabaseReplicationAsync

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

First published in XenServer 6.0.

Returns:

Task

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

disableDatabaseReplication

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

First published in XenServer 6.0.

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getDataSources

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

First published in XenServer 7.0.

Returns:

A set of data sources

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

recordDataSource

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

Start recording the specified data source First published in XenServer 7.0.

Parameters:

dataSource - The data source to record

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

queryDataSource

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

Query the latest value of the specified data source First published in XenServer 7.0.

Parameters:

dataSource - The data source to query

Returns:

The latest value, averaged over the last 5 seconds

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

forgetDataSourceArchives

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

Forget the recorded statistics related to the specified data source First published in XenServer 7.0.

Parameters:

dataSource - The data source whose archives are to be forgotten

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getAll

public static java.util.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. First published in XenServer 4.0.

Returns:

references to all objects

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getAllRecords

public static java.util.Map<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. First published in XenServer 4.0.

Returns:

records of all objects

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException