Class: PVScachestorage

Last published : Oct 01, 2026
Describes the storage that is available to a PVS site for caching purposes
Related information
XenServer 9 Management API

Fields for class: PVScachestorage

Field Type Qualifier Description
host host ref RO/constructor The host on which this object defines PVS cache storage
site PVS_site ref RO/constructor The PVS_site for which this object defines the storage
size int RO/constructor The size of the cache VDI (in bytes)
SR SR ref RO/constructor SR providing storage for the PVS cache
uuid string RO/runtime Unique identifier/object reference
VDI VDI ref RO/runtime The VDI used for caching

RPCs associated with class: PVScachestorage

RPC name: create

Overview:
Create a new PVScachestorage instance, and return its handle.
Signature:
PVS_cache_storage ref create (session ref session_ref, PVS_cache_storage record args)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
PVS_cache_storage record args All constructor arguments
Minimum Role: pool-operator
Return Type: PVS_cache_storage ref
reference to the newly created object

RPC name: destroy

Overview:
Destroy the specified PVScachestorage instance.
Signature:
void destroy (session ref session_ref, PVS_cache_storage ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
PVS_cache_storage ref self reference to the object
Minimum Role: pool-operator
Return Type: void

RPC name: getall

Overview:
Return a list of all the PVScachestorages known to the system.
Signature:
PVS_cache_storage ref set get_all (session ref session_ref)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
Minimum Role: read-only
Return Type: PVS_cache_storage ref set
references to all objects

RPC name: getallrecords

Overview:
Return a map of PVScachestorage references to PVScachestorage records for all PVScachestorages known to the system.
Signature:
(PVS_cache_storage ref -> PVS_cache_storage record) map get_all_records (session ref session_ref)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
Minimum Role: read-only
Return Type: (PVS_cache_storage ref -> PVS_cache_storage record) map
records of all objects

RPC name: getbyuuid

Overview:
Get a reference to the PVScachestorage instance with the specified UUID.
Signature:
PVS_cache_storage ref get_by_uuid (session ref session_ref, string uuid)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
string uuid UUID of object to return
Minimum Role: read-only
Return Type: PVS_cache_storage ref
reference to the object

RPC name: gethost

Overview:
Get the host field of the given PVScachestorage.
Signature:
host ref get_host (session ref session_ref, PVS_cache_storage ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
PVS_cache_storage ref self reference to the object
Minimum Role: read-only
Return Type: host ref
value of the field

RPC name: getrecord

Overview:
Get a record containing the current state of the given PVScachestorage.
Signature:
PVS_cache_storage record get_record (session ref session_ref, PVS_cache_storage ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
PVS_cache_storage ref self reference to the object
Minimum Role: read-only
Return Type: PVS_cache_storage record
all fields from the object

RPC name: getsite

Overview:
Get the site field of the given PVScachestorage.
Signature:
PVS_site ref get_site (session ref session_ref, PVS_cache_storage ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
PVS_cache_storage ref self reference to the object
Minimum Role: read-only
Return Type: PVS_site ref
value of the field

RPC name: getsize

Overview:
Get the size field of the given PVScachestorage.
Signature:
int get_size (session ref session_ref, PVS_cache_storage ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
PVS_cache_storage ref self reference to the object
Minimum Role: read-only
Return Type: int
value of the field

RPC name: getSR

Overview:
Get the SR field of the given PVScachestorage.
Signature:
SR ref get_SR (session ref session_ref, PVS_cache_storage ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
PVS_cache_storage ref self reference to the object
Minimum Role: read-only
Return Type: SR ref
value of the field

RPC name: getuuid

Overview:
Get the uuid field of the given PVScachestorage.
Signature:
string get_uuid (session ref session_ref, PVS_cache_storage ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
PVS_cache_storage ref self reference to the object
Minimum Role: read-only
Return Type: string
value of the field

RPC name: getVDI

Overview:
Get the VDI field of the given PVScachestorage.
Signature:
VDI ref get_VDI (session ref session_ref, PVS_cache_storage ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
PVS_cache_storage ref self reference to the object
Minimum Role: read-only
Return Type: VDI ref
value of the field