Class: PIFmetrics

Last published : Oct 01, 2026
The metrics associated with a physical network interface
Related information
XenServer 8.4 Management API

Fields for class: PIFmetrics

Field Type Qualifier Description
carrier bool RO/runtime Report if the PIF got a carrier or not
device_id string RO/runtime Report device ID
device_name string RO/runtime Report device name
duplex bool RO/runtime Full duplex capability of the link (if available)
io_read_kbs float RO/runtime Removed. Read bandwidth (KiB/s)
io_write_kbs float RO/runtime Removed. Write bandwidth (KiB/s)
last_updated datetime RO/runtime Time at which this information was last updated
other_config (string -> string) map RW additional configuration
pci_bus_path string RO/runtime PCI bus path of the pif (if available)
speed int RO/runtime Speed of the link in Mbit/s (if available)
uuid string RO/runtime Unique identifier/object reference
vendor_id string RO/runtime Report vendor ID
vendor_name string RO/runtime Report vendor name

RPCs associated with class: PIFmetrics

RPC name: addtootherconfig

Overview:
Add the given keyvalue pair to the otherconfig field of the given PIFmetrics.
Signature:
void add_to_other_config (session ref session_ref, PIF_metrics ref self, string key, string value)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
PIF_metrics ref self reference to the object
string key Key to add
string value Value to add
Minimum Role: pool-operator
Return Type: void

RPC name: getall

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

RPC name: getallrecords

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

RPC name: getbyuuid

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

RPC name: getcarrier

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

RPC name: getdeviceid

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

RPC name: getdevicename

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

RPC name: getduplex

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

RPC name: getioreadkbs

This message is removed.
Overview:
Get the io/readkbs field of the given PIFmetrics.
Signature:
float get_io_read_kbs (session ref session_ref, PIF_metrics ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
PIF_metrics ref self reference to the object
Minimum Role: read-only
Return Type: float
value of the field

RPC name: getiowritekbs

This message is removed.
Overview:
Get the io/writekbs field of the given PIFmetrics.
Signature:
float get_io_write_kbs (session ref session_ref, PIF_metrics ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
PIF_metrics ref self reference to the object
Minimum Role: read-only
Return Type: float
value of the field

RPC name: getlastupdated

Overview:
Get the lastupdated field of the given PIFmetrics.
Signature:
datetime get_last_updated (session ref session_ref, PIF_metrics ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
PIF_metrics ref self reference to the object
Minimum Role: read-only
Return Type: datetime
value of the field

RPC name: getotherconfig

Overview:
Get the otherconfig field of the given PIFmetrics.
Signature:
(string -> string) map get_other_config (session ref session_ref, PIF_metrics ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
PIF_metrics ref self reference to the object
Minimum Role: read-only
Return Type: (string -> string) map
value of the field

RPC name: getpcibuspath

Overview:
Get the pcibuspath field of the given PIFmetrics.
Signature:
string get_pci_bus_path (session ref session_ref, PIF_metrics ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
PIF_metrics 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 PIFmetrics.
Signature:
PIF_metrics record get_record (session ref session_ref, PIF_metrics ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
PIF_metrics ref self reference to the object
Minimum Role: read-only
Return Type: PIF_metrics record
all fields from the object

RPC name: getspeed

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

RPC name: getuuid

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

RPC name: getvendorid

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

RPC name: getvendorname

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

RPC name: removefromotherconfig

Overview:
Remove the given key and its corresponding value from the otherconfig field of the given PIFmetrics. If the key is not in that Map, then do nothing.
Signature:
void remove_from_other_config (session ref session_ref, PIF_metrics ref self, string key)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
PIF_metrics ref self reference to the object
string key Key to remove
Minimum Role: pool-operator
Return Type: void

RPC name: setotherconfig

Overview:
Set the otherconfig field of the given PIFmetrics.
Signature:
void set_other_config (session ref session_ref, PIF_metrics ref self, (string -> string) map value)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
PIF_metrics ref self reference to the object
(string -> string) map value New value to set
Minimum Role: pool-operator
Return Type: void