Class: VMmetrics

Last published : Oct 01, 2026
The metrics associated with a VM
Related information
XenServer 9 Management API

Fields for class: VMmetrics

Field Type Qualifier Description
current_domain_type domain_type RO/runtime The current domain type of the VM (for running,suspended, or paused VMs). The last-known domain type for halted VMs.
hvm bool RO/runtime hardware virtual machine
install_time datetime RO/runtime Time at which the VM was installed
last_updated datetime RO/runtime Time at which this information was last updated
memory_actual int RO/runtime Guest's actual memory (bytes)
nested_virt bool RO/runtime VM supports nested virtualisation
nomigrate bool RO/runtime VM is immobile and can't migrate between hosts
numa_node_memory (int -> int) map RO/runtime mapping a NUMA node (int) to an amount of memory (bytes) in that node.
numa_nodes int RO/constructor number of NUMA nodes of the host the VM is using
numa_optimised bool RO/constructor If the VM is optimised for NUMA
other_config (string -> string) map RW additional configuration
start_time datetime RO/runtime Time at which this VM was last booted
state string set RO/runtime The state of the guest, eg blocked, dying etc
uuid string RO/runtime Unique identifier/object reference
VCPUs_CPU (int -> int) map RO/runtime VCPU to PCPU map
VCPUs_flags (int -> string set) map RO/runtime CPU flags (blocked,online,running)
VCPUs_number int RO/runtime Current number of VCPUs
VCPUs_params (string -> string) map RO/runtime The live equivalent to VM.VCPUs_params
VCPUs_utilisation (int -> float) map RO/runtime Removed. Utilisation for all of guest's current VCPUs

RPCs associated with class: VMmetrics

RPC name: addtootherconfig

Overview:
Add the given keyvalue pair to the otherconfig field of the given VMmetrics.
Signature:
void add_to_other_config (session ref session_ref, VM_metrics ref self, string key, string value)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
VM_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 VMmetrics instances known to the system.
Signature:
VM_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_metrics ref set
references to all objects

RPC name: getallrecords

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

RPC name: getbyuuid

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

RPC name: getcurrentdomaintype

Overview:
Get the currentdomaintype field of the given VMmetrics.
Signature:
domain_type get_current_domain_type (session ref session_ref, VM_metrics ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
VM_metrics ref self reference to the object
Minimum Role: read-only
Return Type: domain_type
value of the field

RPC name: gethvm

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

RPC name: getinstalltime

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

RPC name: getlastupdated

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

RPC name: getmemoryactual

Overview:
Get the memory/actual field of the given VMmetrics.
Signature:
int get_memory_actual (session ref session_ref, VM_metrics ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
VM_metrics ref self reference to the object
Minimum Role: read-only
Return Type: int
value of the field

RPC name: getnestedvirt

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

RPC name: getnomigrate

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

RPC name: getnumanodememory

Overview:
Get the numanodememory field of the given VMmetrics.
Signature:
(int -> int) map get_numa_node_memory (session ref session_ref, VM_metrics ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
VM_metrics ref self reference to the object
Minimum Role: read-only
Return Type: (int -> int) map
value of the field

RPC name: getnumanodes

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

RPC name: getnumaoptimised

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

RPC name: getotherconfig

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

RPC name: getstarttime

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

RPC name: getstate

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

RPC name: getuuid

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

RPC name: getVCPUsCPU

Overview:
Get the VCPUs/CPU field of the given VMmetrics.
Signature:
(int -> int) map get_VCPUs_CPU (session ref session_ref, VM_metrics ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
VM_metrics ref self reference to the object
Minimum Role: read-only
Return Type: (int -> int) map
value of the field

RPC name: getVCPUsflags

Overview:
Get the VCPUs/flags field of the given VMmetrics.
Signature:
(int -> string set) map get_VCPUs_flags (session ref session_ref, VM_metrics ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
VM_metrics ref self reference to the object
Minimum Role: read-only
Return Type: (int -> string set) map
value of the field

RPC name: getVCPUsnumber

Overview:
Get the VCPUs/number field of the given VMmetrics.
Signature:
int get_VCPUs_number (session ref session_ref, VM_metrics ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
VM_metrics ref self reference to the object
Minimum Role: read-only
Return Type: int
value of the field

RPC name: getVCPUsparams

Overview:
Get the VCPUs/params field of the given VMmetrics.
Signature:
(string -> string) map get_VCPUs_params (session ref session_ref, VM_metrics ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
VM_metrics ref self reference to the object
Minimum Role: read-only
Return Type: (string -> string) map
value of the field

RPC name: getVCPUsutilisation

This message is removed.
Overview:
Get the VCPUs/utilisation field of the given VMmetrics.
Signature:
(int -> float) map get_VCPUs_utilisation (session ref session_ref, VM_metrics ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
VM_metrics ref self reference to the object
Minimum Role: read-only
Return Type: (int -> float) map
value of the field

RPC name: removefromotherconfig

Overview:
Remove the given key and its corresponding value from the otherconfig field of the given VMmetrics. If the key is not in that Map, then do nothing.
Signature:
void remove_from_other_config (session ref session_ref, VM_metrics ref self, string key)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
VM_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 VMmetrics.
Signature:
void set_other_config (session ref session_ref, VM_metrics ref self, (string -> string) map value)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
VM_metrics ref self reference to the object
(string -> string) map value New value to set
Minimum Role: vm-admin
Return Type: void