Xapi Project Docs

Class: PVS_cache_storage

Describes the storage that is available to a PVS site for caching purposes

Published in:

XenServer 7.1 (ely)

Fields

SR ref SR [RO/constructor]

SR providing storage for the PVS cache

Default value:	OpaqueRef:NULL
Published in:	XenServer 7.1 (ely)

VDI ref VDI [RO/runtime]

The VDI used for caching

Default value:	OpaqueRef:NULL
Published in:	XenServer 7.1 (ely)

host ref host [RO/constructor]

The host on which this object defines PVS cache storage

Default value:	OpaqueRef:NULL
Published in:	XenServer 7.1 (ely)

PVS_site ref site [RO/constructor]

The PVS_site for which this object defines the storage

Default value:	OpaqueRef:NULL
Published in:	XenServer 7.1 (ely)

int size [RO/constructor]

The size of the cache VDI (in bytes)

Default value:	21474836480
Published in:	XenServer 7.1 (ely)

string uuid [RO/runtime]

Unique identifier/object reference

Published in:

XenServer 7.1 (ely)

Messages

PVS_cache_storage ref create (session ref, PVS_cache_storage record)

Create a new PVS_cache_storage instance, and return its handle. The constructor args are: host, SR, site, size (* = non-optional).

Parameters:	session ref session_id	Reference to a valid session
	PVS_cache_storage record args	All constructor arguments
Minimum role:	pool-operator
Result:	reference to the newly created object
Published in:	XenServer 7.1 (ely)

void destroy (session ref, PVS_cache_storage ref)

Destroy the specified PVS_cache_storage instance.

Parameters:	session ref session_id	Reference to a valid session
	PVS_cache_storage ref self	reference to the object
Minimum role:	pool-operator
Published in:	XenServer 7.1 (ely)

SR ref get_SR (session ref, PVS_cache_storage ref)

Get the SR field of the given PVS_cache_storage.

Parameters:	session ref session_id	Reference to a valid session
	PVS_cache_storage ref self	reference to the object
Minimum role:	read-only
Result:	value of the field
Published in:	XenServer 7.1 (ely)

VDI ref get_VDI (session ref, PVS_cache_storage ref)

Get the VDI field of the given PVS_cache_storage.

Parameters:	session ref session_id	Reference to a valid session
	PVS_cache_storage ref self	reference to the object
Minimum role:	read-only
Result:	value of the field
Published in:	XenServer 7.1 (ely)

PVS_cache_storage ref set get_all (session ref)

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

Parameters:	session ref session_id	Reference to a valid session
Minimum role:	read-only
Result:	references to all objects
Published in:	XenServer 7.1 (ely)

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

Return a map of PVS_cache_storage references to PVS_cache_storage records for all PVS_cache_storages known to the system.

Parameters:	session ref session_id	Reference to a valid session
Minimum role:	read-only
Result:	records of all objects
Published in:	XenServer 7.1 (ely)

PVS_cache_storage ref get_by_uuid (session ref, string)

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

Parameters:	session ref session_id	Reference to a valid session
	string uuid	UUID of object to return
Minimum role:	read-only
Result:	reference to the object
Published in:	XenServer 7.1 (ely)

host ref get_host (session ref, PVS_cache_storage ref)

Get the host field of the given PVS_cache_storage.

Parameters:	session ref session_id	Reference to a valid session
	PVS_cache_storage ref self	reference to the object
Minimum role:	read-only
Result:	value of the field
Published in:	XenServer 7.1 (ely)

PVS_cache_storage record get_record (session ref, PVS_cache_storage ref)

Get a record containing the current state of the given PVS_cache_storage.

Parameters:	session ref session_id	Reference to a valid session
	PVS_cache_storage ref self	reference to the object
Minimum role:	read-only
Result:	all fields from the object
Published in:	XenServer 7.1 (ely)

PVS_site ref get_site (session ref, PVS_cache_storage ref)

Get the site field of the given PVS_cache_storage.

Parameters:	session ref session_id	Reference to a valid session
	PVS_cache_storage ref self	reference to the object
Minimum role:	read-only
Result:	value of the field
Published in:	XenServer 7.1 (ely)

int get_size (session ref, PVS_cache_storage ref)

Get the size field of the given PVS_cache_storage.

Parameters:	session ref session_id	Reference to a valid session
	PVS_cache_storage ref self	reference to the object
Minimum role:	read-only
Result:	value of the field
Published in:	XenServer 7.1 (ely)

string get_uuid (session ref, PVS_cache_storage ref)

Get the uuid field of the given PVS_cache_storage.

Parameters:	session ref session_id	Reference to a valid session
	PVS_cache_storage ref self	reference to the object
Minimum role:	read-only
Result:	value of the field
Published in:	XenServer 7.1 (ely)

Class: PVS_cache_storage

Fields

Messages Hide implicit

Classes

Messages