Class: hostmetrics

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

Fields for class: hostmetrics

Field Type Qualifier Description
last_updated datetime RO/runtime Time at which this information was last updated
live bool RO/runtime Pool master thinks this host is live
memory_free int RO/runtime Removed. Free host memory (bytes)
memory_total int RO/runtime Total host memory (bytes)
other_config (string -> string) map RW additional configuration
uuid string RO/runtime Unique identifier/object reference

RPCs associated with class: hostmetrics

RPC name: addtootherconfig

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

RPC name: getallrecords

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

RPC name: getbyuuid

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

RPC name: getlastupdated

Overview:
Get the lastupdated field of the given hostmetrics.
Signature:
datetime get_last_updated (session ref session_ref, host_metrics ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host_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 hostmetrics.
Signature:
bool get_live (session ref session_ref, host_metrics ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host_metrics ref self reference to the object
Minimum Role: read-only
Return Type: bool
value of the field

RPC name: getmemoryfree

This message is removed.
Overview:
Get the memory/free field of the given hostmetrics.
Signature:
int get_memory_free (session ref session_ref, host_metrics ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host_metrics ref self reference to the object
Minimum Role: read-only
Return Type: int
value of the field

RPC name: getmemorytotal

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

RPC name: getotherconfig

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

RPC name: getuuid

Overview:
Get the uuid field of the given hostmetrics.
Signature:
string get_uuid (session ref session_ref, host_metrics ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host_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 hostmetrics. If the key is not in that Map, then do nothing.
Signature:
void remove_from_other_config (session ref session_ref, host_metrics ref self, string key)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host_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 hostmetrics.
Signature:
void set_other_config (session ref session_ref, host_metrics ref self, (string -> string) map value)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host_metrics ref self reference to the object
(string -> string) map value New value to set
Minimum Role: pool-operator
Return Type: void