Develop for XenServer

Class: host_metrics

June 19, 2024

Contributed by:

X X

The metrics associated with a host

Fields for class: host_metrics

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

RPC name: add_to_other_config

Overview:

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

Signature:

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

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

Overview:

Return a list of all the host_metrics instances known to the system.

Signature:

host_metrics 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_metrics ref set

references to all objects

RPC name: get_all_records

Overview:

Return a map of host_metrics references to host_metrics records for all host_metrics instances known to the system.

Signature:

(host_metrics ref -> host_metrics 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_metrics ref -> host_metrics record) map

records of all objects

RPC name: get_by_uuid

Overview:

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

Signature:

host_metrics 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_metrics ref

reference to the object

RPC name: get_last_updated

Overview:

Get the last_updated field of the given host_metrics.

Signature:

datetime get_last_updated (session ref session_ref, host_metrics ref self)
<!--NeedCopy-->

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

Overview:

Get the live field of the given host_metrics.

Signature:

bool get_live (session ref session_ref, host_metrics ref self)
<!--NeedCopy-->

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

This message is removed.

Overview:

Get the memory/free field of the given host_metrics.

Signature:

int get_memory_free (session ref session_ref, host_metrics ref self)
<!--NeedCopy-->

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

Overview:

Get the memory/total field of the given host_metrics.

Signature:

int get_memory_total (session ref session_ref, host_metrics ref self)
<!--NeedCopy-->

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

Overview:

Get the other_config field of the given host_metrics.

Signature:

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

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

Overview:

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

Signature:

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

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

Overview:

Get the uuid field of the given host_metrics.

Signature:

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

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

Overview:

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

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

Overview:

Set the other_config field of the given host_metrics.

Signature:

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

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

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_metrics

June 19, 2024

Contributed by:

X X

June 19, 2024

Contributed by:

X X

Class: host_metrics

Fields for class: host_metrics

RPCs associated with class: host_metrics

RPC name: add_to_other_config

RPC name: get_all

RPC name: get_all_records

RPC name: get_by_uuid

RPC name: get_last_updated

RPC name: get_live

RPC name: get_memory_free

RPC name: get_memory_total

RPC name: get_other_config

RPC name: get_record

RPC name: get_uuid

RPC name: remove_from_other_config

RPC name: set_other_config

In this article