Class: PVSserver

Last published : Oct 01, 2026
individual machine serving provisioning block data
Related information
XenServer 8.4 Management API

Fields for class: PVSserver

Field Type Qualifier Description
addresses string set RO/constructor IPv4 addresses of this server
first_port int RO/constructor First UDP port accepted by this server
last_port int RO/constructor Last UDP port accepted by this server
site PVS_site ref RO/constructor PVS site this server is part of
uuid string RO/runtime Unique identifier/object reference

RPCs associated with class: PVSserver

RPC name: forget

Overview:
forget a PVS server
Signature:
void forget (session ref session_ref, PVS_server ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
PVS_server ref self this PVS server
Minimum Role: pool-operator
Return Type: void

RPC name: getaddresses

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

RPC name: getall

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

RPC name: getallrecords

Overview:
Return a map of PVSserver references to PVSserver records for all PVSservers known to the system.
Signature:
(PVS_server ref -> PVS_server 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_server ref -> PVS_server record) map
records of all objects

RPC name: getbyuuid

Overview:
Get a reference to the PVSserver instance with the specified UUID.
Signature:
PVS_server 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_server ref
reference to the object

RPC name: getfirstport

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

RPC name: getlastport

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

RPC name: getrecord

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

RPC name: getsite

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

RPC name: getuuid

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

RPC name: introduce

Overview:
introduce new PVS server
Signature:
PVS_server ref introduce (session ref session_ref, string set addresses, int first_port, int last_port, PVS_site ref site)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
string set addresses IPv4/IPv6 addresses of the server
int first_port first UDP port accepted by this server
int last_port last UDP port accepted by this server
PVS_site ref site PVS site this server is a part of
Minimum Role: pool-operator
Return Type: PVS_server ref
the new PVS server