/Classes/SR

Classes / SR / index.html

A storage repository

Fields

string uuid
Unique identifier/object reference
string name_label
a human-readable name
string name_description
a notes field containg human-readable description
Set[enum storage_operations] allowed_operations
list of the operations allowed in this state. This list is advisory only and the server state may have changed by the time this field is read by a client.
Map[string,enum storage_operations] current_operations
links each of the running tasks using this object (by reference) to a current_operation enum which describes the nature of the task.
Set[VDI] VDIs
all virtual disks known to this storage repository
Set[PBD] PBDs
describes how particular hosts can see this storage repository
int virtual_allocation
sum of virtual_sizes of all VDIs in this storage repository (in bytes)
int physical_utilisation
physical space currently utilised on this storage repository (in bytes). Note that for sparse disk formats, physical_utilisation may be less than virtual_allocation
int physical_size
total physical size of the repository (in bytes)
string type
type of the storage repository
string content_type
the type of the SR's content, if required (e.g. ISOs)
bool shared
true if this SR is (capable of being) shared between multiple hosts
Map[string,string] other_config
additional configuration
Set[string] tags
user-specified tags for categorization purposes
bool default_vdi_visibility
Map[string,string] sm_config
SM dependent data
Map[string,blob] blobs
Binary blobs associated with this SR
bool local_cache_enabled
True if this SR is assigned to be the local cache for its host

Implicit messages

Record[SR] get_record (session session_id, SR self)
Get a record containing the current state of the given SR.
SR get_by_uuid (session session_id, string uuid)
Get a reference to the SR instance with the specified UUID.
Set[SR] get_by_name_label (session session_id, string label)
Get all the SR instances with the given label.
Set[SR] get_all (session session_id)
Return a list of all the SRs known to the system.
Map[SR,Record[SR]] get_all_records (session session_id)
Return a map of SR references to SR records for all SRs known to the system.

Explicit messages

SR create (session session_id, host host, Map[string,string] device_config, int physical_size, string name_label, string name_description, string type, string content_type, bool shared, Map[string,string] sm_config)
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)
SR introduce (session session_id, string uuid, string name_label, string name_description, string type, string content_type, bool shared, Map[string,string] sm_config)
Introduce a new Storage Repository into the managed system
string make (session session_id, host host, Map[string,string] device_config, int physical_size, string name_label, string name_description, string type, string content_type, Map[string,string] sm_config)
[deprecated]Create a new Storage Repository on disk. This call is deprecated: use SR.create instead.
void destroy (session session_id, SR sr)
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)
void forget (session session_id, SR sr)
Removing specified SR-record from database, without attempting to remove SR from disk
void update (session session_id, SR sr)
Refresh the fields on the SR object
Set[string] get_supported_types (session session_id)
Return a set of all the SR types supported by the system
void scan (session session_id, SR sr)
Refreshes the list of VDIs associated with an SR
string probe (session session_id, host host, Map[string,string] device_config, string type, Map[string,string] sm_config)
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.
void set_shared (session session_id, SR sr, bool value)
Sets the shared flag on the SR
blob create_new_blob (session session_id, SR sr, string name, string mime_type)
Create a placeholder for a named binary blob of data that is associated with this SR
void set_physical_size (session session_id, SR self, int value)
Sets the SR's physical_size field
void set_virtual_allocation (session session_id, SR self, int value)
Sets the SR's virtual_allocation field
void set_physical_utilisation (session session_id, SR self, int value)
Sets the SR's physical_utilisation field
void assert_can_host_ha_statefile (session session_id, SR sr)
Returns successfully if the given SR can host an HA statefile. Otherwise returns an error to explain why not