Class: PVSsite

Last published : Oct 01, 2026
machines serving blocks of data for provisioning VMs
Related information
XenServer 9 Management API

Fields for class: PVSsite

Field Type Qualifier Description
cache_storage PVS_cache_storage ref set RO/runtime The SR used by PVS proxy for the cache
name_description string RW a notes field containing human-readable description
name_label string RW a human-readable name
proxies PVS_proxy ref set RO/runtime The set of proxies associated with the site
PVS_uuid string RO/constructor Unique identifier of the PVS site, as configured in PVS
servers PVS_server ref set RO/runtime The set of PVS servers in the site
uuid string RO/runtime Unique identifier/object reference

RPCs associated with class: PVSsite

RPC name: forget

Overview:
Remove a site's meta data
Signature:
void forget (session ref session_ref, PVS_site ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
PVS_site ref self this PVS site
Minimum Role: pool-operator
Return Type: void
Possible Error Codes: PVS_SITE_CONTAINS_RUNNING_PROXIES, PVS_SITE_CONTAINS_SERVERS

RPC name: getall

Overview:
Return a list of all the PVSsites known to the system.
Signature:
PVS_site 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_site ref set
references to all objects

RPC name: getallrecords

Overview:
Return a map of PVSsite references to PVSsite records for all PVSsites known to the system.
Signature:
(PVS_site ref -> PVS_site 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_site ref -> PVS_site record) map
records of all objects

RPC name: getbynamelabel

Overview:
Get all the PVSsite instances with the given label.
Signature:
PVS_site ref set get_by_name_label (session ref session_ref, string label)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
string label label of object to return
Minimum Role: read-only
Return Type: PVS_site ref set
references to objects with matching names

RPC name: getbyuuid

Overview:
Get a reference to the PVSsite instance with the specified UUID.
Signature:
PVS_site 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_site ref
reference to the object

RPC name: getcachestorage

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

RPC name: getnamedescription

Overview:
Get the name/description field of the given PVSsite.
Signature:
string get_name_description (session ref session_ref, PVS_site ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
PVS_site ref self reference to the object
Minimum Role: read-only
Return Type: string
value of the field

RPC name: getnamelabel

Overview:
Get the name/label field of the given PVSsite.
Signature:
string get_name_label (session ref session_ref, PVS_site ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
PVS_site ref self reference to the object
Minimum Role: read-only
Return Type: string
value of the field

RPC name: getproxies

Overview:
Get the proxies field of the given PVSsite.
Signature:
PVS_proxy ref set get_proxies (session ref session_ref, PVS_site ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
PVS_site ref self reference to the object
Minimum Role: read-only
Return Type: PVS_proxy ref set
value of the field

RPC name: getPVSuuid

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

RPC name: getrecord

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

RPC name: getservers

Overview:
Get the servers field of the given PVSsite.
Signature:
PVS_server ref set get_servers (session ref session_ref, PVS_site ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
PVS_site ref self reference to the object
Minimum Role: read-only
Return Type: PVS_server ref set
value of the field

RPC name: getuuid

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

RPC name: introduce

Overview:
Introduce new PVS site
Signature:
PVS_site ref introduce (session ref session_ref, string name_label, string name_description, string PVS_uuid)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
string name_label name of the PVS site
string name_description description of the PVS site
string PVS_uuid unique identifier of the PVS site
Minimum Role: pool-operator
Return Type: PVS_site ref
the new PVS site

RPC name: setnamedescription

Overview:
Set the name/description field of the given PVSsite.
Signature:
void set_name_description (session ref session_ref, PVS_site ref self, string value)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
PVS_site ref self reference to the object
string value New value to set
Minimum Role: pool-operator
Return Type: void

RPC name: setnamelabel

Overview:
Set the name/label field of the given PVSsite.
Signature:
void set_name_label (session ref session_ref, PVS_site ref self, string value)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
PVS_site ref self reference to the object
string value New value to set
Minimum Role: pool-operator
Return Type: void

RPC name: setPVSuuid

Overview:
Update the PVS UUID of the PVS site
Signature:
void set_PVS_uuid (session ref session_ref, PVS_site ref self, string value)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
PVS_site ref self this PVS site
string value PVS UUID to be used
Minimum Role: pool-operator
Return Type: void