Develop for XenServer

Class: VM_guest_metrics

October 11, 2024

Contributed by:

X X

The metrics reported by the guest (as opposed to inferred from outside)

Fields for class: VM_guest_metrics

Field	Type	Qualifier	Description
`can_use_hotplug_vbd`	`tristate_type`	RO/runtime	The guest’s statement of whether it supports VBD hotplug, i.e. whether it is capable of responding immediately to instantiation of a new VBD by bringing online a new PV block device. If the guest states that it is not capable, then the VBD plug and unplug operations will not be allowed while the guest is running.
`can_use_hotplug_vif`	`tristate_type`	RO/runtime	The guest’s statement of whether it supports VIF hotplug, i.e. whether it is capable of responding immediately to instantiation of a new VIF by bringing online a new PV network device. If the guest states that it is not capable, then the VIF plug and unplug operations will not be allowed while the guest is running.
`disks`	`(string -> string) map`	RO/runtime	Removed. This field exists but has no data.
`last_updated`	`datetime`	RO/runtime	Time at which this information was last updated
`live`	`bool`	RO/runtime	True if the guest is sending heartbeat messages via the guest agent
`memory`	`(string -> string) map`	RO/runtime	Removed. This field exists but has no data. Use the memory and memory_internal_free RRD data-sources instead.
`netbios_name`	`(string -> string) map`	RO/runtime	The NETBIOS name of the machine
`networks`	`(string -> string) map`	RO/runtime	network configuration
`os_version`	`(string -> string) map`	RO/runtime	version of the OS
`other`	`(string -> string) map`	RO/runtime	anything else
`other_config`	`(string -> string) map`	RW	additional configuration
`PV_drivers_detected`	`bool`	RO/runtime	At least one of the guest’s devices has successfully connected to the backend.
`PV_drivers_up_to_date`	`bool`	RO/runtime	Deprecated. Logically equivalent to PV_drivers_detected
`PV_drivers_version`	`(string -> string) map`	RO/runtime	version of the PV drivers
`uuid`	`string`	RO/runtime	Unique identifier/object reference

RPCs associated with class: VM_guest_metrics

RPC name: add_to_other_config

Overview:

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

Signature:

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

Arguments:

Type	Name	Description
`session ref`	`session_ref`	Reference to a valid session
`VM_guest_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: get_all

Overview:

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

Signature:

VM_guest_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: VM_guest_metrics ref set

references to all objects

RPC name: get_all_records

Overview:

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

Signature:

(VM_guest_metrics ref -> VM_guest_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: (VM_guest_metrics ref -> VM_guest_metrics record) map

records of all objects

RPC name: get_by_uuid

Overview:

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

Signature:

VM_guest_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: VM_guest_metrics ref

reference to the object

RPC name: get_can_use_hotplug_vbd

Overview:

Get the can_use_hotplug_vbd field of the given VM_guest_metrics.

Signature:

tristate_type get_can_use_hotplug_vbd (session ref session_ref, VM_guest_metrics ref self)
<!--NeedCopy-->

Arguments:

Type	Name	Description
`session ref`	`session_ref`	Reference to a valid session
`VM_guest_metrics ref`	`self`	reference to the object

Minimum Role: read-only

Return Type: tristate_type

value of the field

RPC name: get_can_use_hotplug_vif

Overview:

Get the can_use_hotplug_vif field of the given VM_guest_metrics.

Signature:

tristate_type get_can_use_hotplug_vif (session ref session_ref, VM_guest_metrics ref self)
<!--NeedCopy-->

Arguments:

Type	Name	Description
`session ref`	`session_ref`	Reference to a valid session
`VM_guest_metrics ref`	`self`	reference to the object

Minimum Role: read-only

Return Type: tristate_type

value of the field

RPC name: get_disks

This message is removed.

Overview:

Get the disks field of the given VM_guest_metrics.

Signature:

(string -> string) map get_disks (session ref session_ref, VM_guest_metrics ref self)
<!--NeedCopy-->

Arguments:

Type	Name	Description
`session ref`	`session_ref`	Reference to a valid session
`VM_guest_metrics ref`	`self`	reference to the object

Minimum Role: read-only

Return Type: (string -> string) map

value of the field

RPC name: get_last_updated

Overview:

Get the last_updated field of the given VM_guest_metrics.

Signature:

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

Arguments:

Type	Name	Description
`session ref`	`session_ref`	Reference to a valid session
`VM_guest_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 VM_guest_metrics.

Signature:

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

Arguments:

Type	Name	Description
`session ref`	`session_ref`	Reference to a valid session
`VM_guest_metrics ref`	`self`	reference to the object

Minimum Role: read-only

Return Type: bool

value of the field

RPC name: get_memory

This message is removed.

Overview:

Get the memory field of the given VM_guest_metrics.

Signature:

(string -> string) map get_memory (session ref session_ref, VM_guest_metrics ref self)
<!--NeedCopy-->

Arguments:

Type	Name	Description
`session ref`	`session_ref`	Reference to a valid session
`VM_guest_metrics ref`	`self`	reference to the object

Minimum Role: read-only

Return Type: (string -> string) map

value of the field

RPC name: get_netbios_name

Overview:

Get the netbios_name field of the given VM_guest_metrics.

Signature:

(string -> string) map get_netbios_name (session ref session_ref, VM_guest_metrics ref self)
<!--NeedCopy-->

Arguments:

Type	Name	Description
`session ref`	`session_ref`	Reference to a valid session
`VM_guest_metrics ref`	`self`	reference to the object

Minimum Role: read-only

Return Type: (string -> string) map

value of the field

RPC name: get_networks

Overview:

Get the networks field of the given VM_guest_metrics.

Signature:

(string -> string) map get_networks (session ref session_ref, VM_guest_metrics ref self)
<!--NeedCopy-->

Arguments:

Type	Name	Description
`session ref`	`session_ref`	Reference to a valid session
`VM_guest_metrics ref`	`self`	reference to the object

Minimum Role: read-only

Return Type: (string -> string) map

value of the field

RPC name: get_os_version

Overview:

Get the os_version field of the given VM_guest_metrics.

Signature:

(string -> string) map get_os_version (session ref session_ref, VM_guest_metrics ref self)
<!--NeedCopy-->

Arguments:

Type	Name	Description
`session ref`	`session_ref`	Reference to a valid session
`VM_guest_metrics ref`	`self`	reference to the object

Minimum Role: read-only

Return Type: (string -> string) map

value of the field

RPC name: get_other

Overview:

Get the other field of the given VM_guest_metrics.

Signature:

(string -> string) map get_other (session ref session_ref, VM_guest_metrics ref self)
<!--NeedCopy-->

Arguments:

Type	Name	Description
`session ref`	`session_ref`	Reference to a valid session
`VM_guest_metrics ref`	`self`	reference to the object

Minimum Role: read-only

Return Type: (string -> string) map

value of the field

RPC name: get_other_config

Overview:

Get the other_config field of the given VM_guest_metrics.

Signature:

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

Arguments:

Type	Name	Description
`session ref`	`session_ref`	Reference to a valid session
`VM_guest_metrics ref`	`self`	reference to the object

Minimum Role: read-only

Return Type: (string -> string) map

value of the field

RPC name: get_PV_drivers_detected

Overview:

Get the PV_drivers_detected field of the given VM_guest_metrics.

Signature:

bool get_PV_drivers_detected (session ref session_ref, VM_guest_metrics ref self)
<!--NeedCopy-->

Arguments:

Type	Name	Description
`session ref`	`session_ref`	Reference to a valid session
`VM_guest_metrics ref`	`self`	reference to the object

Minimum Role: read-only

Return Type: bool

value of the field

RPC name: get_PV_drivers_up_to_date

This message is deprecated.

Overview:

Get the PV_drivers_up_to_date field of the given VM_guest_metrics.

Signature:

bool get_PV_drivers_up_to_date (session ref session_ref, VM_guest_metrics ref self)
<!--NeedCopy-->

Arguments:

Type	Name	Description
`session ref`	`session_ref`	Reference to a valid session
`VM_guest_metrics ref`	`self`	reference to the object

Minimum Role: read-only

Return Type: bool

value of the field

RPC name: get_PV_drivers_version

Overview:

Get the PV_drivers_version field of the given VM_guest_metrics.

Signature:

(string -> string) map get_PV_drivers_version (session ref session_ref, VM_guest_metrics ref self)
<!--NeedCopy-->

Arguments:

Type	Name	Description
`session ref`	`session_ref`	Reference to a valid session
`VM_guest_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 VM_guest_metrics.

Signature:

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

Arguments:

Type	Name	Description
`session ref`	`session_ref`	Reference to a valid session
`VM_guest_metrics ref`	`self`	reference to the object

Minimum Role: read-only

Return Type: VM_guest_metrics record

all fields from the object

RPC name: get_uuid

Overview:

Get the uuid field of the given VM_guest_metrics.

Signature:

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

Arguments:

Type	Name	Description
`session ref`	`session_ref`	Reference to a valid session
`VM_guest_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 VM_guest_metrics. If the key is not in that Map, then do nothing.

Signature:

void remove_from_other_config (session ref session_ref, VM_guest_metrics ref self, string key)
<!--NeedCopy-->

Arguments:

Type	Name	Description
`session ref`	`session_ref`	Reference to a valid session
`VM_guest_metrics ref`	`self`	reference to the object
`string`	`key`	Key to remove

Minimum Role: vm-admin

Return Type: void

RPC name: set_other_config

Overview:

Set the other_config field of the given VM_guest_metrics.

Signature:

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

Arguments:

Type	Name	Description
`session ref`	`session_ref`	Reference to a valid session
`VM_guest_metrics ref`	`self`	reference to the object
`(string -> string) map`	`value`	New value to set

Minimum Role: vm-admin

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

October 11, 2024

Contributed by:

X X

October 11, 2024

Contributed by:

X X

Class: VM_guest_metrics

Fields for class: VM_guest_metrics

RPCs associated with class: VM_guest_metrics

RPC name: add_to_other_config

RPC name: get_all

RPC name: get_all_records

RPC name: get_by_uuid

RPC name: get_can_use_hotplug_vbd

RPC name: get_can_use_hotplug_vif

RPC name: get_disks

RPC name: get_last_updated

RPC name: get_live

RPC name: get_memory

RPC name: get_netbios_name

RPC name: get_networks

RPC name: get_os_version

RPC name: get_other

RPC name: get_other_config

RPC name: get_PV_drivers_detected

RPC name: get_PV_drivers_up_to_date

RPC name: get_PV_drivers_version

RPC name: get_record

RPC name: get_uuid

RPC name: remove_from_other_config

RPC name: set_other_config

In this article