SR :: XAPI Toolstack Developer Documentation

Class: SR

A storage repository

Enums

storage_operations

Fields

enum storage_operations set allowed_operations [RO/runtime]

(string → blob ref) map blobs [RO/runtime]

bool clustered [RO/runtime]

string content_type [RO/constructor]

(string → enum storage_operations) map current_operations [RO/runtime]

DR_task ref introduced_by [RO/runtime]

bool is_tools_sr [RO/runtime]

bool local_cache_enabled [RO/runtime]

string name_description [RO/constructor]

string name_label [RO/constructor]

(string → string) map other_config [RW]

PBD ref set PBDs [RO/runtime]

int physical_size [RO/constructor]

int physical_utilisation [RO/runtime]

bool shared [RO/runtime]

(string → string) map sm_config [RW]

string set tags [RW]

string type [RO/constructor]

string uuid [RO/runtime]

VDI ref set VDIs [RO/runtime]

int virtual_allocation [RO/runtime]

Messages

void add_tags (session ref, SR ref, string)

void add_to_other_config (session ref, SR ref, string, string)

void add_to_sm_config (session ref, SR ref, string, string)

void assert_can_host_ha_statefile (session ref, SR ref)

void assert_supports_database_replication (session ref, SR ref)

SR ref create (session ref, host ref, (string → string) map, int, string, string, string, string, bool, (string → string) map)

blob ref create_new_blob (session ref, SR ref, string, string, bool)

void destroy (session ref, SR ref)

void disable_database_replication (session ref, SR ref)

void enable_database_replication (session ref, SR ref)

void forget (session ref, SR ref)

void forget_data_source_archives (session ref, SR ref, string)

SR ref set get_all (session ref)

(SR ref → SR record) map get_all_records (session ref)

enum storage_operations set get_allowed_operations (session ref, SR ref)

(string → blob ref) map get_blobs (session ref, SR ref)

SR ref set get_by_name_label (session ref, string)

SR ref get_by_uuid (session ref, string)

bool get_clustered (session ref, SR ref)

string get_content_type (session ref, SR ref)

(string → enum storage_operations) map get_current_operations (session ref, SR ref)

data_source record set get_data_sources (session ref, SR ref)

DR_task ref get_introduced_by (session ref, SR ref)

bool get_is_tools_sr (session ref, SR ref)

bool get_local_cache_enabled (session ref, SR ref)

string get_name_description (session ref, SR ref)

string get_name_label (session ref, SR ref)

(string → string) map get_other_config (session ref, SR ref)

PBD ref set get_PBDs (session ref, SR ref)

int get_physical_size (session ref, SR ref)

int get_physical_utilisation (session ref, SR ref)

SR record get_record (session ref, SR ref)

bool get_shared (session ref, SR ref)

(string → string) map get_sm_config (session ref, SR ref)

string set get_supported_types (session ref)

string set get_tags (session ref, SR ref)

string get_type (session ref, SR ref)

string get_uuid (session ref, SR ref)

VDI ref set get_VDIs (session ref, SR ref)

int get_virtual_allocation (session ref, SR ref)

SR ref introduce (session ref, string, string, string, string, string, bool, (string → string) map)

Deprecated

string make (session ref, host ref, (string → string) map, int, string, string, string, string, (string → string) map)

string probe (session ref, host ref, (string → string) map, string, (string → string) map)

probe_result record set probe_ext (session ref, host ref, (string → string) map, string, (string → string) map)

float query_data_source (session ref, SR ref, string)

void record_data_source (session ref, SR ref, string)

void remove_from_other_config (session ref, SR ref, string)

void remove_from_sm_config (session ref, SR ref, string)

void remove_tags (session ref, SR ref, string)

void scan (session ref, SR ref)

void set_name_description (session ref, SR ref, string)

void set_name_label (session ref, SR ref, string)

void set_other_config (session ref, SR ref, (string → string) map)

void set_physical_size (session ref, SR ref, int)

void set_shared (session ref, SR ref, bool)

void set_sm_config (session ref, SR ref, (string → string) map)

void set_tags (session ref, SR ref, string set)

void update (session ref, SR ref)

Values:	scan	Scanning backends for new or deleted VDIs
	destroy	Destroying the SR
	forget	Forgetting about SR
	plug	Plugging a PBD into this SR
	unplug	Unplugging a PBD from this SR
	update	Refresh the fields on the SR
	vdi_create	Creating a new VDI
	vdi_introduce	Introducing a new VDI
	vdi_destroy	Destroying a VDI
	vdi_resize	Resizing a VDI
	vdi_clone	Cloneing a VDI
	vdi_snapshot	Snapshotting a VDI
	vdi_mirror	Mirroring a VDI
	vdi_enable_cbt	Enabling changed block tracking for a VDI
	vdi_disable_cbt	Disabling changed block tracking for a VDI
	vdi_data_destroy	Deleting the data of the VDI
	vdi_list_changed_blocks	Exporting a bitmap that shows the changed blocks between two VDIs
	vdi_set_on_boot	Setting the on_boot field of the VDI
	pbd_create	Creating a PBD for this SR
	pbd_destroy	Destroying one of this SR's PBDs

Default value:	{}
Published in:	XenServer 4.0 (rio)	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.

Default value:	{}
Published in:	XenServer 5.0 (orlando)	Binary blobs associated with this SR

Default value:	false
Published in:	XenServer 7.0 (dundee)

Default value:	{}
Published in:	XenServer 4.0 (rio)	links each of the running tasks using this object (by reference) to a current_operation enum which describes the nature of the task.

Default value:	OpaqueRef:NULL
Published in:	XenServer 6.0 (boston)	The disaster recovery task which introduced this SR

Default value:	{}
Published in:	XenServer 4.1 (miami)	SM dependent data

Parameters:	session ref session_id	Reference to a valid session
	SR ref self	reference to the object
	string value	New value to add
Minimum role:	vm-operator
Published in:	XenServer 5.0 (orlando)	user-specified tags for categorization purposes

Class: SR

Enums

Fields

Messages Hide implicit

Messages