Class: PVSproxy

Last published : Oct 01, 2026
a proxy connects a VM/VIF with a PVS site
Related information
XenServer 9 Management API

Fields for class: PVSproxy

Field Type Qualifier Description
currently_attached bool RO/runtime true = VM is currently proxied
site PVS_site ref RO/constructor PVS site this proxy is part of
status pvs_proxy_status RO/runtime The run-time status of the proxy
uuid string RO/runtime Unique identifier/object reference
VIF VIF ref RO/constructor VIF of the VM using the proxy

RPCs associated with class: PVSproxy

RPC name: create

Overview:
Configure a VM/VIF to use a PVS proxy
Signature:
PVS_proxy ref create (session ref session_ref, PVS_site ref site, VIF ref VIF)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
PVS_site ref site PVS site that we proxy for
VIF ref VIF VIF for the VM that needs to be proxied
Minimum Role: pool-operator
Return Type: PVS_proxy ref
The reference of the created PVS proxy

RPC name: destroy

Overview:
remove or switch off a PVS proxy for this VM
Signature:
void destroy (session ref session_ref, PVS_proxy ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
PVS_proxy ref self this PVS proxy
Minimum Role: pool-operator
Return Type: void

RPC name: getall

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

RPC name: getallrecords

Overview:
Return a map of PVSproxy references to PVSproxy records for all PVSproxys known to the system.
Signature:
(PVS_proxy ref -> PVS_proxy 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_proxy ref -> PVS_proxy record) map
records of all objects

RPC name: getbyuuid

Overview:
Get a reference to the PVSproxy instance with the specified UUID.
Signature:
PVS_proxy 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_proxy ref
reference to the object

RPC name: getcurrentlyattached

Overview:
Get the currentlyattached field of the given PVSproxy.
Signature:
bool get_currently_attached (session ref session_ref, PVS_proxy ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
PVS_proxy ref self reference to the object
Minimum Role: read-only
Return Type: bool
value of the field

RPC name: getrecord

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

RPC name: getsite

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

RPC name: getstatus

Overview:
Get the status field of the given PVSproxy.
Signature:
pvs_proxy_status get_status (session ref session_ref, PVS_proxy ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
PVS_proxy ref self reference to the object
Minimum Role: read-only
Return Type: pvs_proxy_status
value of the field

RPC name: getuuid

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

RPC name: getVIF

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