Class: VIFmetrics

Last published : Oct 01, 2026
This class is removed.
The metrics associated with a virtual network device
Related information
XenServer 8.4 Management API

Fields for class: VIFmetrics

Field Type Qualifier Description
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 Removed. Time at which this information was last updated
other_config (string -> string) map RW Removed. additional configuration
uuid string RO/runtime Removed. Unique identifier/object reference

RPCs associated with class: VIFmetrics

RPC name: addtootherconfig

This message is removed.
Overview:
Add the given keyvalue pair to the otherconfig field of the given VIFmetrics.
Signature:
void add_to_other_config (session ref session_ref, VIF_metrics ref self, string key, string value)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
VIF_metrics ref self reference to the object
string key Key to add
string value Value to add
Minimum Role: vm-admin
Return Type: void

RPC name: getall

This message is removed.
Overview:
Return a list of all the VIFmetrics instances known to the system.
Signature:
VIF_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: VIF_metrics ref set
references to all objects

RPC name: getallrecords

This message is removed.
Overview:
Return a map of VIFmetrics references to VIFmetrics records for all VIFmetrics instances known to the system.
Signature:
(VIF_metrics ref -> VIF_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: (VIF_metrics ref -> VIF_metrics record) map
records of all objects

RPC name: getbyuuid

This message is removed.
Overview:
Get a reference to the VIFmetrics instance with the specified UUID.
Signature:
VIF_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: VIF_metrics ref
reference to the object

RPC name: getioreadkbs

This message is removed.
Overview:
Get the io/readkbs field of the given VIFmetrics.
Signature:
float get_io_read_kbs (session ref session_ref, VIF_metrics ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
VIF_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 VIFmetrics.
Signature:
float get_io_write_kbs (session ref session_ref, VIF_metrics ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
VIF_metrics ref self reference to the object
Minimum Role: read-only
Return Type: float
value of the field

RPC name: getlastupdated

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

RPC name: getotherconfig

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

RPC name: getrecord

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

RPC name: getuuid

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

RPC name: removefromotherconfig

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

RPC name: setotherconfig

This message is removed.
Overview:
Set the otherconfig field of the given VIFmetrics.
Signature:
void set_other_config (session ref session_ref, VIF_metrics ref self, (string -> string) map value)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
VIF_metrics ref self reference to the object
(string -> string) map value New value to set
Minimum Role: vm-admin
Return Type: void