Class: hostcpu

Last published : Oct 01, 2026
This class is deprecated.
A physical CPU
Related information
XenServer 8.4 Management API

Fields for class: hostcpu

Field Type Qualifier Description
family int RO/runtime Deprecated. the family (number) of the physical CPU
features string RO/runtime Deprecated. the physical CPU feature bitmap
flags string RO/runtime Deprecated. the flags of the physical CPU (a decoded version of the features field)
host host ref RO/runtime Deprecated. the host the CPU is in
model int RO/runtime Deprecated. the model number of the physical CPU
modelname string RO/runtime Deprecated. the model name of the physical CPU
number int RO/runtime Deprecated. the number of the physical CPU within the host
other_config (string -> string) map RW Deprecated. additional configuration
speed int RO/runtime Deprecated. the speed of the physical CPU
stepping string RO/runtime Deprecated. the stepping of the physical CPU
utilisation float RO/runtime Deprecated. the current CPU utilisation
uuid string RO/runtime Deprecated. Unique identifier/object reference
vendor string RO/runtime Deprecated. the vendor of the physical CPU

RPCs associated with class: hostcpu

RPC name: addtootherconfig

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

This message is deprecated.
Overview:
Return a list of all the hostcpus known to the system.
Signature:
host_cpu 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_cpu ref set
references to all objects

RPC name: getallrecords

This message is deprecated.
Overview:
Return a map of hostcpu references to hostcpu records for all hostcpus known to the system.
Signature:
(host_cpu ref -> host_cpu 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_cpu ref -> host_cpu record) map
records of all objects

RPC name: getbyuuid

This message is deprecated.
Overview:
Get a reference to the hostcpu instance with the specified UUID.
Signature:
host_cpu 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_cpu ref
reference to the object

RPC name: getfamily

This message is deprecated.
Overview:
Get the family field of the given hostcpu.
Signature:
int get_family (session ref session_ref, host_cpu ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host_cpu ref self reference to the object
Minimum Role: read-only
Return Type: int
value of the field

RPC name: getfeatures

This message is deprecated.
Overview:
Get the features field of the given hostcpu.
Signature:
string get_features (session ref session_ref, host_cpu ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host_cpu ref self reference to the object
Minimum Role: read-only
Return Type: string
value of the field

RPC name: getflags

This message is deprecated.
Overview:
Get the flags field of the given hostcpu.
Signature:
string get_flags (session ref session_ref, host_cpu ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host_cpu ref self reference to the object
Minimum Role: read-only
Return Type: string
value of the field

RPC name: gethost

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

RPC name: getmodel

This message is deprecated.
Overview:
Get the model field of the given hostcpu.
Signature:
int get_model (session ref session_ref, host_cpu ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host_cpu ref self reference to the object
Minimum Role: read-only
Return Type: int
value of the field

RPC name: getmodelname

This message is deprecated.
Overview:
Get the modelname field of the given hostcpu.
Signature:
string get_modelname (session ref session_ref, host_cpu ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host_cpu ref self reference to the object
Minimum Role: read-only
Return Type: string
value of the field

RPC name: getnumber

This message is deprecated.
Overview:
Get the number field of the given hostcpu.
Signature:
int get_number (session ref session_ref, host_cpu ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host_cpu ref self reference to the object
Minimum Role: read-only
Return Type: int
value of the field

RPC name: getotherconfig

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

RPC name: getspeed

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

RPC name: getstepping

This message is deprecated.
Overview:
Get the stepping field of the given hostcpu.
Signature:
string get_stepping (session ref session_ref, host_cpu ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host_cpu ref self reference to the object
Minimum Role: read-only
Return Type: string
value of the field

RPC name: getutilisation

This message is deprecated.
Overview:
Get the utilisation field of the given hostcpu.
Signature:
float get_utilisation (session ref session_ref, host_cpu ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host_cpu ref self reference to the object
Minimum Role: read-only
Return Type: float
value of the field

RPC name: getuuid

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

RPC name: getvendor

This message is deprecated.
Overview:
Get the vendor field of the given hostcpu.
Signature:
string get_vendor (session ref session_ref, host_cpu ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host_cpu ref self reference to the object
Minimum Role: read-only
Return Type: string
value of the field

RPC name: removefromotherconfig

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

RPC name: setotherconfig

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