Class: VMguestmetrics

Last published : Oct 01, 2026
The metrics reported by the guest as opposed to inferred from outside
Related information
XenServer 8.4 Management API

Fields for class: VMguestmetrics

Field Type Qualifier Description
can_use_hotplug_vbd tristate_type RO/runtime The guest's statement of whether it supports VBD hotplug, i.e. whether it is capable of responding immediately to instantiation of a new VBD by bringing online a new PV block device. If the guest states that it is not capable, then the VBD plug and unplug operations will not be allowed while the guest is running.
can_use_hotplug_vif tristate_type RO/runtime The guest's statement of whether it supports VIF hotplug, i.e. whether it is capable of responding immediately to instantiation of a new VIF by bringing online a new PV network device. If the guest states that it is not capable, then the VIF plug and unplug operations will not be allowed while the guest is running.
disks (string -> string) map RO/runtime Removed. This field exists but has no data.
last_updated datetime RO/runtime Time at which this information was last updated
live bool RO/runtime True if the guest is sending heartbeat messages via the guest agent
memory (string -> string) map RO/runtime Removed. This field exists but has no data. Use the memory and memory_internal_free RRD data-sources instead.
netbios_name (string -> string) map RO/runtime The NETBIOS name of the machine
networks (string -> string) map RO/runtime network configuration
os_version (string -> string) map RO/runtime version of the OS
other (string -> string) map RO/runtime anything else
other_config (string -> string) map RW additional configuration
PV_drivers_detected bool RO/runtime At least one of the guest's devices has successfully connected to the backend.
PV_drivers_up_to_date bool RO/runtime Deprecated. Logically equivalent to PV_drivers_detected
PV_drivers_version (string -> string) map RO/runtime version of the PV drivers
services (string -> string) map RO/runtime The guest's services data.
uuid string RO/runtime Unique identifier/object reference

RPCs associated with class: VMguestmetrics

RPC name: addtootherconfig

Overview:
Add the given keyvalue pair to the otherconfig field of the given VMguestmetrics.
Signature:
void add_to_other_config (session ref session_ref, VM_guest_metrics ref self, string key, string value)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
VM_guest_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

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

RPC name: getallrecords

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

RPC name: getbyuuid

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

RPC name: getcanusehotplugvbd

Overview:
Get the canusehotplugvbd field of the given VMguestmetrics.
Signature:
tristate_type get_can_use_hotplug_vbd (session ref session_ref, VM_guest_metrics ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
VM_guest_metrics ref self reference to the object
Minimum Role: read-only
Return Type: tristate_type
value of the field

RPC name: getcanusehotplugvif

Overview:
Get the canusehotplugvif field of the given VMguestmetrics.
Signature:
tristate_type get_can_use_hotplug_vif (session ref session_ref, VM_guest_metrics ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
VM_guest_metrics ref self reference to the object
Minimum Role: read-only
Return Type: tristate_type
value of the field

RPC name: getdisks

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

RPC name: getlastupdated

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

RPC name: getlive

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

RPC name: getmemory

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

RPC name: getnetbiosname

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

RPC name: getnetworks

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

RPC name: getosversion

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

RPC name: getother

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

RPC name: getotherconfig

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

RPC name: getPVdriversdetected

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

RPC name: getPVdriversuptodate

This message is deprecated.
Overview:
Get the PVdriversuptodate field of the given VMguestmetrics.
Signature:
bool get_PV_drivers_up_to_date (session ref session_ref, VM_guest_metrics ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
VM_guest_metrics ref self reference to the object
Minimum Role: read-only
Return Type: bool
value of the field

RPC name: getPVdriversversion

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

RPC name: getrecord

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

RPC name: getservices

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

RPC name: getuuid

Overview:
Get the uuid field of the given VMguestmetrics.
Signature:
string get_uuid (session ref session_ref, VM_guest_metrics ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
VM_guest_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 VMguestmetrics. If the key is not in that Map, then do nothing.
Signature:
void remove_from_other_config (session ref session_ref, VM_guest_metrics ref self, string key)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
VM_guest_metrics ref self reference to the object
string key Key to remove
Minimum Role: vm-admin
Return Type: void

RPC name: setotherconfig

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