View Source XenAPI.SR (XenAPI v0.3.0)

A storage repository

Link to this section Summary

Functions

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

Add the given value to the tags field of the given SR. If the value is already in that Set, then do nothing. (Raise error on XMLRPC failure)

Add the given key-value pair to the other_config field of the given SR.

Add the given key-value pair to the other_config field of the given SR. (Raise error on XMLRPC failure)

Add the given key-value pair to the sm_config field of the given SR.

Add the given key-value pair to the sm_config field of the given SR. (Raise error on XMLRPC failure)

Returns successfully if the given SR can host an HA statefile. Otherwise returns an error to explain why not

Returns successfully if the given SR can host an HA statefile. Otherwise returns an error to explain why not (Raise error on XMLRPC failure)

Returns successfully if the given SR supports database replication. Otherwise returns an error to explain why not.

Returns successfully if the given SR supports database replication. Otherwise returns an error to explain why not. (Raise error on XMLRPC failure)

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)

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) (Raise error on XMLRPC failure)

Create a placeholder for a named binary blob of data that is associated with this SR

Create a placeholder for a named binary blob of data that is associated with this SR (Raise error on XMLRPC failure)

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)

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) (Raise error on XMLRPC failure)

(Raise error on XMLRPC failure)

(Raise error on XMLRPC failure)

Removing specified SR-record from database, without attempting to remove SR from disk

Removing specified SR-record from database, without attempting to remove SR from disk (Raise error on XMLRPC failure)

Forget the recorded statistics related to the specified data source

Forget the recorded statistics related to the specified data source (Raise error on XMLRPC failure)

Return a list of all the SRs known to the system.

Return a list of all the SRs known to the system. (Raise error on XMLRPC failure)

Return a map of SR references to SR records for all SRs known to the system.

Return a map of SR references to SR records for all SRs known to the system. (Raise error on XMLRPC failure)

Get the allowed_operations field of the given SR.

Get the allowed_operations field of the given SR. (Raise error on XMLRPC failure)

Get the blobs field of the given SR.

Get the blobs field of the given SR. (Raise error on XMLRPC failure)

Get all the SR instances with the given label.

Get all the SR instances with the given label. (Raise error on XMLRPC failure)

Get a reference to the SR instance with the specified UUID.

Get a reference to the SR instance with the specified UUID. (Raise error on XMLRPC failure)

Get the clustered field of the given SR.

Get the clustered field of the given SR. (Raise error on XMLRPC failure)

Get the content_type field of the given SR.

Get the content_type field of the given SR. (Raise error on XMLRPC failure)

Get the current_operations field of the given SR.

Get the current_operations field of the given SR. (Raise error on XMLRPC failure)

(Raise error on XMLRPC failure)

Get the introduced_by field of the given SR.

Get the introduced_by field of the given SR. (Raise error on XMLRPC failure)

Get the is_tools_sr field of the given SR.

Get the is_tools_sr field of the given SR. (Raise error on XMLRPC failure)

Get the local_cache_enabled field of the given SR.

Get the local_cache_enabled field of the given SR. (Raise error on XMLRPC failure)

Get the name/description field of the given SR.

Get the name/description field of the given SR. (Raise error on XMLRPC failure)

Get the name/label field of the given SR.

Get the name/label field of the given SR. (Raise error on XMLRPC failure)

Get the other_config field of the given SR.

Get the other_config field of the given SR. (Raise error on XMLRPC failure)

Get the PBDs field of the given SR.

Get the PBDs field of the given SR. (Raise error on XMLRPC failure)

Get the physical_size field of the given SR.

Get the physical_size field of the given SR. (Raise error on XMLRPC failure)

Get the physical_utilisation field of the given SR.

Get the physical_utilisation field of the given SR. (Raise error on XMLRPC failure)

Get a record containing the current state of the given SR. Returns XenAPI.SR struct.

Get a record containing the current state of the given SR. Returns XenAPI.SR struct. (Raise error on XMLRPC failure)

Get the shared field of the given SR.

Get the shared field of the given SR. (Raise error on XMLRPC failure)

Get the sm_config field of the given SR.

Get the sm_config field of the given SR. (Raise error on XMLRPC failure)

Return a set of all the SR types supported by the system

Return a set of all the SR types supported by the system (Raise error on XMLRPC failure)

Get the tags field of the given SR.

Get the tags field of the given SR. (Raise error on XMLRPC failure)

Get the type field of the given SR.

Get the type field of the given SR. (Raise error on XMLRPC failure)

Get the uuid field of the given SR.

Get the uuid field of the given SR. (Raise error on XMLRPC failure)

Get the VDIs field of the given SR.

Get the VDIs field of the given SR. (Raise error on XMLRPC failure)

Get the virtual_allocation field of the given SR.

Get the virtual_allocation field of the given SR. (Raise error on XMLRPC failure)

Introduce a new Storage Repository into the managed system (Raise error on XMLRPC failure)

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

Create a new Storage Repository on disk. This call is deprecated: use SR.create instead. (Raise error on XMLRPC failure)

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.

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. (Raise error on XMLRPC failure)

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.

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. (Raise error on XMLRPC failure)

Query the latest value of the specified data source

Query the latest value of the specified data source (Raise error on XMLRPC failure)

Start recording the specified data source

Start recording the specified data source (Raise error on XMLRPC failure)

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.

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. (Raise error on XMLRPC failure)

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.

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. (Raise error on XMLRPC failure)

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

Remove the given value from the tags field of the given SR. If the value is not in that Set, then do nothing. (Raise error on XMLRPC failure)

Refreshes the list of VDIs associated with an SR

Refreshes the list of VDIs associated with an SR (Raise error on XMLRPC failure)

Set the name description of the SR

Set the name description of the SR (Raise error on XMLRPC failure)

Set the name label of the SR

Set the name label of the SR (Raise error on XMLRPC failure)

Set the other_config field of the given SR.

Set the other_config field of the given SR. (Raise error on XMLRPC failure)

Sets the SR's physical_size field

Sets the SR's physical_size field (Raise error on XMLRPC failure)

Sets the shared flag on the SR

Sets the shared flag on the SR (Raise error on XMLRPC failure)

Set the sm_config field of the given SR.

Set the sm_config field of the given SR. (Raise error on XMLRPC failure)

Set the tags field of the given SR.

Set the tags field of the given SR. (Raise error on XMLRPC failure)

Refresh the fields on the SR object

Refresh the fields on the SR object (Raise error on XMLRPC failure)

Link to this section Functions

Link to this function

add_tags(xen_session, sr_ref, value)

View Source

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

Link to this function

add_tags!(xen_session, sr_ref, value)

View Source

Add the given value to the tags field of the given SR. If the value is already in that Set, then do nothing. (Raise error on XMLRPC failure)

Link to this function

add_to_other_config(xen_session, sr_ref, key, value)

View Source

Add the given key-value pair to the other_config field of the given SR.

Link to this function

add_to_other_config!(xen_session, sr_ref, key, value)

View Source

Add the given key-value pair to the other_config field of the given SR. (Raise error on XMLRPC failure)

Link to this function

add_to_sm_config(xen_session, sr_ref, key, value)

View Source

Add the given key-value pair to the sm_config field of the given SR.

Link to this function

add_to_sm_config!(xen_session, sr_ref, key, value)

View Source

Add the given key-value pair to the sm_config field of the given SR. (Raise error on XMLRPC failure)

Link to this function

assert_can_host_ha_statefile(xen_session, sr)

View Source

Returns successfully if the given SR can host an HA statefile. Otherwise returns an error to explain why not

Link to this function

assert_can_host_ha_statefile!(xen_session, sr)

View Source

Returns successfully if the given SR can host an HA statefile. Otherwise returns an error to explain why not (Raise error on XMLRPC failure)

Link to this function

assert_supports_database_replication(xen_session, sr)

View Source

Returns successfully if the given SR supports database replication. Otherwise returns an error to explain why not.

Link to this function

assert_supports_database_replication!(xen_session, sr)

View Source

Returns successfully if the given SR supports database replication. Otherwise returns an error to explain why not. (Raise error on XMLRPC failure)

Link to this function

create(xen_session, host, device_config, physical_size, name_label, name_description, type, content_type, shared, sm_config)

View Source

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)

Link to this function

create!(xen_session, host, device_config, physical_size, name_label, name_description, type, content_type, shared, sm_config)

View Source

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) (Raise error on XMLRPC failure)

Link to this function

create_new_blob(xen_session, sr, name, mime_type, public)

View Source

Create a placeholder for a named binary blob of data that is associated with this SR

Link to this function

create_new_blob!(xen_session, sr, name, mime_type, public)

View Source

Create a placeholder for a named binary blob of data that is associated with this SR (Raise error on XMLRPC failure)

Link to this function

destroy(xen_session, sr)

View Source

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)

Link to this function

destroy!(xen_session, sr)

View Source

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) (Raise error on XMLRPC failure)

Link to this function

disable_database_replication(xen_session, sr)

View Source
Link to this function

disable_database_replication!(xen_session, sr)

View Source

(Raise error on XMLRPC failure)

Link to this function

enable_database_replication(xen_session, sr)

View Source
Link to this function

enable_database_replication!(xen_session, sr)

View Source

(Raise error on XMLRPC failure)

Removing specified SR-record from database, without attempting to remove SR from disk

Link to this function

forget!(xen_session, sr)

View Source

Removing specified SR-record from database, without attempting to remove SR from disk (Raise error on XMLRPC failure)

Link to this function

forget_data_source_archives(xen_session, sr, data_source)

View Source

Forget the recorded statistics related to the specified data source

Link to this function

forget_data_source_archives!(xen_session, sr, data_source)

View Source

Forget the recorded statistics related to the specified data source (Raise error on XMLRPC failure)

Return a list of all the SRs known to the system.

Return a list of all the SRs known to the system. (Raise error on XMLRPC failure)

Link to this function

get_all_records(xen_session)

View Source

Return a map of SR references to SR records for all SRs known to the system.

Link to this function

get_all_records!(xen_session)

View Source

Return a map of SR references to SR records for all SRs known to the system. (Raise error on XMLRPC failure)

Link to this function

get_allowed_operations(xen_session, sr_ref)

View Source

Get the allowed_operations field of the given SR.

Link to this function

get_allowed_operations!(xen_session, sr_ref)

View Source

Get the allowed_operations field of the given SR. (Raise error on XMLRPC failure)

Link to this function

get_blobs(xen_session, sr_ref)

View Source

Get the blobs field of the given SR.

Link to this function

get_blobs!(xen_session, sr_ref)

View Source

Get the blobs field of the given SR. (Raise error on XMLRPC failure)

Link to this function

get_by_name_label(xen_session, label)

View Source

Get all the SR instances with the given label.

Link to this function

get_by_name_label!(xen_session, label)

View Source

Get all the SR instances with the given label. (Raise error on XMLRPC failure)

Link to this function

get_by_uuid(xen_session, uuid)

View Source

Get a reference to the SR instance with the specified UUID.

Link to this function

get_by_uuid!(xen_session, uuid)

View Source

Get a reference to the SR instance with the specified UUID. (Raise error on XMLRPC failure)

Link to this function

get_clustered(xen_session, sr_ref)

View Source

Get the clustered field of the given SR.

Link to this function

get_clustered!(xen_session, sr_ref)

View Source

Get the clustered field of the given SR. (Raise error on XMLRPC failure)

Link to this function

get_content_type(xen_session, sr_ref)

View Source

Get the content_type field of the given SR.

Link to this function

get_content_type!(xen_session, sr_ref)

View Source

Get the content_type field of the given SR. (Raise error on XMLRPC failure)

Link to this function

get_current_operations(xen_session, sr_ref)

View Source

Get the current_operations field of the given SR.

Link to this function

get_current_operations!(xen_session, sr_ref)

View Source

Get the current_operations field of the given SR. (Raise error on XMLRPC failure)

Link to this function

get_data_sources(xen_session, sr)

View Source
Link to this function

get_data_sources!(xen_session, sr)

View Source

(Raise error on XMLRPC failure)

Link to this function

get_introduced_by(xen_session, sr_ref)

View Source

Get the introduced_by field of the given SR.

Link to this function

get_introduced_by!(xen_session, sr_ref)

View Source

Get the introduced_by field of the given SR. (Raise error on XMLRPC failure)

Link to this function

get_is_tools_sr(xen_session, sr_ref)

View Source

Get the is_tools_sr field of the given SR.

Link to this function

get_is_tools_sr!(xen_session, sr_ref)

View Source

Get the is_tools_sr field of the given SR. (Raise error on XMLRPC failure)

Link to this function

get_local_cache_enabled(xen_session, sr_ref)

View Source

Get the local_cache_enabled field of the given SR.

Link to this function

get_local_cache_enabled!(xen_session, sr_ref)

View Source

Get the local_cache_enabled field of the given SR. (Raise error on XMLRPC failure)

Link to this function

get_name_description(xen_session, sr_ref)

View Source

Get the name/description field of the given SR.

Link to this function

get_name_description!(xen_session, sr_ref)

View Source

Get the name/description field of the given SR. (Raise error on XMLRPC failure)

Link to this function

get_name_label(xen_session, sr_ref)

View Source

Get the name/label field of the given SR.

Link to this function

get_name_label!(xen_session, sr_ref)

View Source

Get the name/label field of the given SR. (Raise error on XMLRPC failure)

Link to this function

get_other_config(xen_session, sr_ref)

View Source

Get the other_config field of the given SR.

Link to this function

get_other_config!(xen_session, sr_ref)

View Source

Get the other_config field of the given SR. (Raise error on XMLRPC failure)

Link to this function

get_PBDs(xen_session, sr_ref)

View Source

Get the PBDs field of the given SR.

Link to this function

get_PBDs!(xen_session, sr_ref)

View Source

Get the PBDs field of the given SR. (Raise error on XMLRPC failure)

Link to this function

get_physical_size(xen_session, sr_ref)

View Source

Get the physical_size field of the given SR.

Link to this function

get_physical_size!(xen_session, sr_ref)

View Source

Get the physical_size field of the given SR. (Raise error on XMLRPC failure)

Link to this function

get_physical_utilisation(xen_session, sr_ref)

View Source

Get the physical_utilisation field of the given SR.

Link to this function

get_physical_utilisation!(xen_session, sr_ref)

View Source

Get the physical_utilisation field of the given SR. (Raise error on XMLRPC failure)

Link to this function

get_record(xen_session, sr_ref)

View Source

Get a record containing the current state of the given SR. Returns XenAPI.SR struct.

Link to this function

get_record!(xen_session, sr_ref)

View Source

Get a record containing the current state of the given SR. Returns XenAPI.SR struct. (Raise error on XMLRPC failure)

Link to this function

get_shared(xen_session, sr_ref)

View Source

Get the shared field of the given SR.

Link to this function

get_shared!(xen_session, sr_ref)

View Source

Get the shared field of the given SR. (Raise error on XMLRPC failure)

Link to this function

get_sm_config(xen_session, sr_ref)

View Source

Get the sm_config field of the given SR.

Link to this function

get_sm_config!(xen_session, sr_ref)

View Source

Get the sm_config field of the given SR. (Raise error on XMLRPC failure)

Link to this function

get_supported_types(xen_session)

View Source

Return a set of all the SR types supported by the system

Link to this function

get_supported_types!(xen_session)

View Source

Return a set of all the SR types supported by the system (Raise error on XMLRPC failure)

Link to this function

get_tags(xen_session, sr_ref)

View Source

Get the tags field of the given SR.

Link to this function

get_tags!(xen_session, sr_ref)

View Source

Get the tags field of the given SR. (Raise error on XMLRPC failure)

Link to this function

get_type(xen_session, sr_ref)

View Source

Get the type field of the given SR.

Link to this function

get_type!(xen_session, sr_ref)

View Source

Get the type field of the given SR. (Raise error on XMLRPC failure)

Link to this function

get_uuid(xen_session, sr_ref)

View Source

Get the uuid field of the given SR.

Link to this function

get_uuid!(xen_session, sr_ref)

View Source

Get the uuid field of the given SR. (Raise error on XMLRPC failure)

Link to this function

get_VDIs(xen_session, sr_ref)

View Source

Get the VDIs field of the given SR.

Link to this function

get_VDIs!(xen_session, sr_ref)

View Source

Get the VDIs field of the given SR. (Raise error on XMLRPC failure)

Link to this function

get_virtual_allocation(xen_session, sr_ref)

View Source

Get the virtual_allocation field of the given SR.

Link to this function

get_virtual_allocation!(xen_session, sr_ref)

View Source

Get the virtual_allocation field of the given SR. (Raise error on XMLRPC failure)

Link to this function

introduce(xen_session, uuid, name_label, name_description, type, content_type, shared, sm_config)

View Source

Introduce a new Storage Repository into the managed system

Link to this function

introduce!(xen_session, uuid, name_label, name_description, type, content_type, shared, sm_config)

View Source

Introduce a new Storage Repository into the managed system (Raise error on XMLRPC failure)

Link to this function

make(xen_session, host, device_config, physical_size, name_label, name_description, type, content_type, sm_config)

View Source

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

Link to this function

make!(xen_session, host, device_config, physical_size, name_label, name_description, type, content_type, sm_config)

View Source

Create a new Storage Repository on disk. This call is deprecated: use SR.create instead. (Raise error on XMLRPC failure)

Link to this function

probe(xen_session, host, device_config, type, sm_config)

View Source

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.

Link to this function

probe!(xen_session, host, device_config, type, sm_config)

View Source

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. (Raise error on XMLRPC failure)

Link to this function

probe_ext(xen_session, host, device_config, type, sm_config)

View Source

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.

Link to this function

probe_ext!(xen_session, host, device_config, type, sm_config)

View Source

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. (Raise error on XMLRPC failure)

Link to this function

query_data_source(xen_session, sr, data_source)

View Source

Query the latest value of the specified data source

Link to this function

query_data_source!(xen_session, sr, data_source)

View Source

Query the latest value of the specified data source (Raise error on XMLRPC failure)

Link to this function

record_data_source(xen_session, sr, data_source)

View Source

Start recording the specified data source

Link to this function

record_data_source!(xen_session, sr, data_source)

View Source

Start recording the specified data source (Raise error on XMLRPC failure)

Link to this function

remove_from_other_config(xen_session, sr_ref, key)

View Source

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.

Link to this function

remove_from_other_config!(xen_session, sr_ref, key)

View Source

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. (Raise error on XMLRPC failure)

Link to this function

remove_from_sm_config(xen_session, sr_ref, key)

View Source

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.

Link to this function

remove_from_sm_config!(xen_session, sr_ref, key)

View Source

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. (Raise error on XMLRPC failure)

Link to this function

remove_tags(xen_session, sr_ref, value)

View Source

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

Link to this function

remove_tags!(xen_session, sr_ref, value)

View Source

Remove the given value from the tags field of the given SR. If the value is not in that Set, then do nothing. (Raise error on XMLRPC failure)

Refreshes the list of VDIs associated with an SR

Refreshes the list of VDIs associated with an SR (Raise error on XMLRPC failure)

Link to this function

set_name_description(xen_session, sr, value)

View Source

Set the name description of the SR

Link to this function

set_name_description!(xen_session, sr, value)

View Source

Set the name description of the SR (Raise error on XMLRPC failure)

Link to this function

set_name_label(xen_session, sr, value)

View Source

Set the name label of the SR

Link to this function

set_name_label!(xen_session, sr, value)

View Source

Set the name label of the SR (Raise error on XMLRPC failure)

Link to this function

set_other_config(xen_session, sr_ref, value)

View Source

Set the other_config field of the given SR.

Link to this function

set_other_config!(xen_session, sr_ref, value)

View Source

Set the other_config field of the given SR. (Raise error on XMLRPC failure)

Link to this function

set_physical_size(xen_session, sr_ref, value)

View Source

Sets the SR's physical_size field

Link to this function

set_physical_size!(xen_session, sr_ref, value)

View Source

Sets the SR's physical_size field (Raise error on XMLRPC failure)

Link to this function

set_shared(xen_session, sr, value)

View Source

Sets the shared flag on the SR

Link to this function

set_shared!(xen_session, sr, value)

View Source

Sets the shared flag on the SR (Raise error on XMLRPC failure)

Link to this function

set_sm_config(xen_session, sr_ref, value)

View Source

Set the sm_config field of the given SR.

Link to this function

set_sm_config!(xen_session, sr_ref, value)

View Source

Set the sm_config field of the given SR. (Raise error on XMLRPC failure)

Link to this function

set_tags(xen_session, sr_ref, value)

View Source

Set the tags field of the given SR.

Link to this function

set_tags!(xen_session, sr_ref, value)

View Source

Set the tags field of the given SR. (Raise error on XMLRPC failure)

Refresh the fields on the SR object

Link to this function

update!(xen_session, sr)

View Source

Refresh the fields on the SR object (Raise error on XMLRPC failure)