Develop for XenServer

Class: host_cpu

June 19, 2024

Contributed by:

X X

This class is deprecated.

A physical CPU

Fields for class: host_cpu

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: host_cpu

RPC name: add_to_other_config

This message is deprecated.

Overview:

Add the given key-value pair to the other_config field of the given host_cpu.

Signature:

void add_to_other_config (session ref session_ref, host_cpu ref self, string key, string value)
<!--NeedCopy-->

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: get_all

This message is deprecated.

Overview:

Return a list of all the host_cpus known to the system.

Signature:

host_cpu ref set get_all (session ref session_ref)
<!--NeedCopy-->

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: get_all_records

This message is deprecated.

Overview:

Return a map of host_cpu references to host_cpu records for all host_cpus known to the system.

Signature:

(host_cpu ref -> host_cpu record) map get_all_records (session ref session_ref)
<!--NeedCopy-->

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: get_by_uuid

This message is deprecated.

Overview:

Get a reference to the host_cpu instance with the specified UUID.

Signature:

host_cpu ref get_by_uuid (session ref session_ref, string uuid)
<!--NeedCopy-->

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: get_family

This message is deprecated.

Overview:

Get the family field of the given host_cpu.

Signature:

int get_family (session ref session_ref, host_cpu ref self)
<!--NeedCopy-->

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: get_features

This message is deprecated.

Overview:

Get the features field of the given host_cpu.

Signature:

string get_features (session ref session_ref, host_cpu ref self)
<!--NeedCopy-->

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: get_flags

This message is deprecated.

Overview:

Get the flags field of the given host_cpu.

Signature:

string get_flags (session ref session_ref, host_cpu ref self)
<!--NeedCopy-->

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: get_host

This message is deprecated.

Overview:

Get the host field of the given host_cpu.

Signature:

host ref get_host (session ref session_ref, host_cpu ref self)
<!--NeedCopy-->

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: get_model

This message is deprecated.

Overview:

Get the model field of the given host_cpu.

Signature:

int get_model (session ref session_ref, host_cpu ref self)
<!--NeedCopy-->

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: get_modelname

This message is deprecated.

Overview:

Get the modelname field of the given host_cpu.

Signature:

string get_modelname (session ref session_ref, host_cpu ref self)
<!--NeedCopy-->

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: get_number

This message is deprecated.

Overview:

Get the number field of the given host_cpu.

Signature:

int get_number (session ref session_ref, host_cpu ref self)
<!--NeedCopy-->

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: get_other_config

This message is deprecated.

Overview:

Get the other_config field of the given host_cpu.

Signature:

(string -> string) map get_other_config (session ref session_ref, host_cpu ref self)
<!--NeedCopy-->

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: get_record

This message is deprecated.

Overview:

Get a record containing the current state of the given host_cpu.

Signature:

host_cpu record get_record (session ref session_ref, host_cpu ref self)
<!--NeedCopy-->

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: get_speed

This message is deprecated.

Overview:

Get the speed field of the given host_cpu.

Signature:

int get_speed (session ref session_ref, host_cpu ref self)
<!--NeedCopy-->

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: get_stepping

This message is deprecated.

Overview:

Get the stepping field of the given host_cpu.

Signature:

string get_stepping (session ref session_ref, host_cpu ref self)
<!--NeedCopy-->

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: get_utilisation

This message is deprecated.

Overview:

Get the utilisation field of the given host_cpu.

Signature:

float get_utilisation (session ref session_ref, host_cpu ref self)
<!--NeedCopy-->

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: get_uuid

This message is deprecated.

Overview:

Get the uuid field of the given host_cpu.

Signature:

string get_uuid (session ref session_ref, host_cpu ref self)
<!--NeedCopy-->

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: get_vendor

This message is deprecated.

Overview:

Get the vendor field of the given host_cpu.

Signature:

string get_vendor (session ref session_ref, host_cpu ref self)
<!--NeedCopy-->

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: remove_from_other_config

This message is deprecated.

Overview:

Remove the given key and its corresponding value from the other_config field of the given host_cpu. 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)
<!--NeedCopy-->

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: set_other_config

This message is deprecated.

Overview:

Set the other_config field of the given host_cpu.

Signature:

void set_other_config (session ref session_ref, host_cpu ref self, (string -> string) map value)
<!--NeedCopy-->

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

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

Class: host_cpu

June 19, 2024

Contributed by:

X X

June 19, 2024

Contributed by:

X X

Was this helpful

Class: host_cpu

Fields for class: host_cpu

RPCs associated with class: host_cpu

RPC name: add_to_other_config

RPC name: get_all

RPC name: get_all_records

RPC name: get_by_uuid

RPC name: get_family

RPC name: get_features

RPC name: get_flags

RPC name: get_host

RPC name: get_model

RPC name: get_modelname

RPC name: get_number

RPC name: get_other_config

RPC name: get_record

RPC name: get_speed

RPC name: get_stepping

RPC name: get_utilisation

RPC name: get_uuid

RPC name: get_vendor

RPC name: remove_from_other_config

RPC name: set_other_config

In this article