SR

java.lang.Object
- com.xensource.xenapi.XenAPIObject
- - com.xensource.xenapi.SR

```
public class SR
extends XenAPIObject
```
A storage repository

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class SR.Record
Represents all the fields in a SR

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 to this object.

Fields
Modifier and Type	Field and Description
`protected java.lang.String`	`ref` The XenAPI reference to this object.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated 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.
`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)
`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)
`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
`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
`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.
`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
`Task`	`forgetAsync(Connection c)` Removing specified SR-record from database, without attempting to remove SR from disk
`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.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.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
`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, java.util.Map<java.lang.String,java.lang.String> smConfig)` Introduce a new Storage Repository into the managed system
`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
`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, 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.
`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
`Task`	`scanAsync(Connection c)` Refreshes the list of VDIs associated with an SR
`void`	`setNameDescription(Connection c, java.lang.String description)` Set the name/description field of the given SR.
`void`	`setNameLabel(Connection c, java.lang.String label)` Set the name/label field of the given SR.
`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
`void`	`setPhysicalUtilisation(Connection c, java.lang.Long value)` Sets the SR's physical_utilisation field
`void`	`setShared(Connection c, java.lang.Boolean value)` Sets the shared flag on the SR
`Task`	`setSharedAsync(Connection c, java.lang.Boolean value)` Sets the shared flag on the SR
`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.
`void`	`setVirtualAllocation(Connection c, java.lang.Long value)` Sets the SR's virtual_allocation field
`java.lang.String`	`toWireString()`
`void`	`update(Connection c)` Refresh the fields on the SR object
`Task`	`updateAsync(Connection c)` Refresh the fields on the SR object

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 to this object.

Method Detail

toWireString
```
public java.lang.String toWireString()
```
Specified by:

toWireString in class XenAPIObject

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

Returns:: value of the field
Throws:: Types.BadServerResponse; Types.XenAPIException; org.apache.xmlrpc.XmlRpcException

setNameLabel

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

Set the name/label field of the given SR.

Parameters:: label - New value to set
Throws:: Types.BadServerResponse; Types.XenAPIException; org.apache.xmlrpc.XmlRpcException

setNameDescription

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

Set the name/description field of the given SR.

Parameters:: description - New value to set
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.

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.

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.

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.

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.

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.

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.

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.

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.

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,
                               java.util.Map<java.lang.String,java.lang.String> smConfig)
                        throws Types.BadServerResponse,
                               Types.VersionException,
                               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)

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
Returns:: Task
Throws:: Types.BadServerResponse; Types.VersionException; 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.VersionException,
                        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)

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

Returns:

The reference of the newly created Storage Repository.

Throws:

Types.BadServerResponse

Types.VersionException

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,
                                  java.util.Map<java.lang.String,java.lang.String> smConfig)
                           throws Types.BadServerResponse,
                                  Types.VersionException,
                                  Types.XenAPIException,
                                  org.apache.xmlrpc.XmlRpcException

Introduce a new Storage Repository into the managed system

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
Returns:: Task
Throws:: Types.BadServerResponse; Types.VersionException; 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.VersionException,
                           Types.XenAPIException,
                           org.apache.xmlrpc.XmlRpcException

Introduce a new Storage Repository into the managed system

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
Returns:: The reference of the newly introduced Storage Repository.
Throws:: Types.BadServerResponse; Types.VersionException; 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.VersionException,
                                         Types.XenAPIException,
                                         org.apache.xmlrpc.XmlRpcException

Deprecated.

Create a new Storage Repository on disk. This call is deprecated: use SR.create instead.

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
Returns:: Task
Throws:: Types.BadServerResponse; Types.VersionException; 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.VersionException,
                                                Types.XenAPIException,
                                                org.apache.xmlrpc.XmlRpcException

Deprecated.

Create a new Storage Repository on disk. This call is deprecated: use SR.create instead.

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
Returns:: The uuid of the newly created Storage Repository.
Throws:: Types.BadServerResponse; Types.VersionException; 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)

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)

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

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

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

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

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

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

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

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.

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.

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

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

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

Parameters:: value - True if the SR is shared
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

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

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

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

Parameters:: value - The new value of the SR's physical_size
Throws:: Types.BadServerResponse; Types.XenAPIException; org.apache.xmlrpc.XmlRpcException

setVirtualAllocation

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

Sets the SR's virtual_allocation field

Parameters:: value - The new value of the SR's virtual_allocation
Throws:: Types.BadServerResponse; Types.XenAPIException; org.apache.xmlrpc.XmlRpcException

setPhysicalUtilisation

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

Sets the SR's physical_utilisation field

Parameters:: value - The new value of the SR's physical utilisation
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

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