Class: VM_guest_metrics
The metrics reported by the guest (as opposed to inferred from outside)
Published in: XenServer 4.0 (rio)
The metrics reported by the guest (as opposed to inferred from outside)
Enums
tristate_type
Values: yes
Known to be true
no
Known to be false
unspecified
Unknown or unspecified
Fields
bool
PV_drivers_detected
[RO/runtime]
At least one of the guest's devices has successfully connected to the backend.
Default value: false
Published in: XenServer 7.0 (dundee)
Deprecated
bool
PV_drivers_up_to_date
[RO/runtime]
Logically equivalent to PV_drivers_detected
Published in: XenServer 4.0 (rio)
true if the PV drivers appear to be up to date
Deprecated in: XenServer 7.0 (dundee)
Deprecated in favour of PV_drivers_detected, and redefined in terms of it
(string → string) map
PV_drivers_version
[RO/runtime]
version of the PV drivers
Published in: XenServer 4.0 (rio)
version of the PV drivers
enum tristate_type
can_use_hotplug_vbd
[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.
Default value: unspecified
Published in: XenServer 7.0 (dundee)
To be used where relevant and available instead of checking PV driver version.
enum tristate_type
can_use_hotplug_vif
[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.
Default value: unspecified
Published in: XenServer 7.0 (dundee)
To be used where relevant and available instead of checking PV driver version.
Removed
(string → string) map
disks
[RO/runtime]
This field exists but has no data.
Default value: {}
Published in: XenServer 4.0 (rio)
Disk configuration/free space
Deprecated in: XenServer 5.0 (orlando)
Dummy transition
Removed in: XenServer 5.0 (orlando)
No data
datetime
last_updated
[RO/runtime]
Time at which this information was last updated
Published in: XenServer 4.0 (rio)
Time at which this information was last updated
bool
live
[RO/runtime]
True if the guest is sending heartbeat messages via the guest agent
Default value: false
Published in: XenServer 5.0 (orlando)
True if the guest is sending heartbeat messages via the guest agent
Removed
(string → string) map
memory
[RO/runtime]
This field exists but has no data. Use the memory and memory_internal_free RRD data-sources instead.
Default value: {}
Published in: XenServer 4.0 (rio)
free/used/total
Deprecated in: XenServer 5.5 (george)
Dummy transition
Removed in: XenServer 5.5 (george)
Disabled in favour of the RRDs, to improve scalability
Prototype
(string → string) map
netbios_name
[RO/runtime]
The NETBIOS name of the machine
Default value: {}
Prototyped in: XAPI 24.28.0 (24.28.0)
(string → string) map
networks
[RO/runtime]
network configuration
Published in: XenServer 4.0 (rio)
network configuration
(string → string) map
os_version
[RO/runtime]
version of the OS
Published in: XenServer 4.0 (rio)
version of the OS
(string → string) map
other
[RO/runtime]
anything else
Published in: XenServer 4.0 (rio)
anything else
(string → string) map
other_config
[RW]
additional configuration
Default value: {}
Published in: XenServer 5.0 (orlando)
additional configuration
string
uuid
[RO/runtime]
Unique identifier/object reference
Published in: XenServer 4.0 (rio)
Unique identifier/object reference
Messages
Hide implicit
void
add_to_other_config
(session ref, VM_guest_metrics ref, string, string)
Add the given key-value pair to the other_config field of the given VM_guest_metrics.
Parameters: session ref session_id
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
Published in: XenServer 5.0 (orlando)
additional configuration
bool
get_PV_drivers_detected
(session ref, VM_guest_metrics ref)
Get the PV_drivers_detected field of the given VM_guest_metrics.
Parameters: session ref session_id
Reference to a valid session
VM_guest_metrics ref self
reference to the object
Minimum role: read-only
Result: value of the field
Published in: XenServer 7.0 (dundee)
Deprecated
bool
get_PV_drivers_up_to_date
(session ref, VM_guest_metrics ref)
Get the PV_drivers_up_to_date field of the given VM_guest_metrics.
Parameters: session ref session_id
Reference to a valid session
VM_guest_metrics ref self
reference to the object
Minimum role: read-only
Result: value of the field
Published in: XenServer 4.0 (rio)
true if the PV drivers appear to be up to date
Deprecated in: XenServer 7.0 (dundee)
Deprecated in favour of PV_drivers_detected, and redefined in terms of it
(string → string) map
get_PV_drivers_version
(session ref, VM_guest_metrics ref)
Get the PV_drivers_version field of the given VM_guest_metrics.
Parameters: session ref session_id
Reference to a valid session
VM_guest_metrics ref self
reference to the object
Minimum role: read-only
Result: value of the field
Published in: XenServer 4.0 (rio)
version of the PV drivers
VM_guest_metrics ref set
get_all
(session ref)
Return a list of all the VM_guest_metrics instances known to the system.
Parameters: session ref session_id
Reference to a valid session
Minimum role: read-only
Result: references to all objects
Published in: XenServer 4.0 (rio)
The metrics reported by the guest (as opposed to inferred from outside)
(VM_guest_metrics ref → VM_guest_metrics record) map
get_all_records
(session ref)
Return a map of VM_guest_metrics references to VM_guest_metrics records for all VM_guest_metrics instances known to the system.
Parameters: session ref session_id
Reference to a valid session
Minimum role: read-only
Result: records of all objects
Published in: XenServer 4.0 (rio)
The metrics reported by the guest (as opposed to inferred from outside)
VM_guest_metrics ref
get_by_uuid
(session ref, string)
Get a reference to the VM_guest_metrics instance with the specified UUID.
Parameters: session ref session_id
Reference to a valid session
string uuid
UUID of object to return
Minimum role: read-only
Result: reference to the object
Published in: XenServer 4.0 (rio)
The metrics reported by the guest (as opposed to inferred from outside)
enum tristate_type
get_can_use_hotplug_vbd
(session ref, VM_guest_metrics ref)
Get the can_use_hotplug_vbd field of the given VM_guest_metrics.
Parameters: session ref session_id
Reference to a valid session
VM_guest_metrics ref self
reference to the object
Minimum role: read-only
Result: value of the field
Published in: XenServer 7.0 (dundee)
To be used where relevant and available instead of checking PV driver version.
enum tristate_type
get_can_use_hotplug_vif
(session ref, VM_guest_metrics ref)
Get the can_use_hotplug_vif field of the given VM_guest_metrics.
Parameters: session ref session_id
Reference to a valid session
VM_guest_metrics ref self
reference to the object
Minimum role: read-only
Result: value of the field
Published in: XenServer 7.0 (dundee)
To be used where relevant and available instead of checking PV driver version.
Removed
(string → string) map
get_disks
(session ref, VM_guest_metrics ref)
Get the disks field of the given VM_guest_metrics.
Parameters: session ref session_id
Reference to a valid session
VM_guest_metrics ref self
reference to the object
Minimum role: read-only
Result: value of the field
Published in: XenServer 4.0 (rio)
Disk configuration/free space
Deprecated in: XenServer 5.0 (orlando)
Dummy transition
Removed in: XenServer 5.0 (orlando)
No data
datetime
get_last_updated
(session ref, VM_guest_metrics ref)
Get the last_updated field of the given VM_guest_metrics.
Parameters: session ref session_id
Reference to a valid session
VM_guest_metrics ref self
reference to the object
Minimum role: read-only
Result: value of the field
Published in: XenServer 4.0 (rio)
Time at which this information was last updated
bool
get_live
(session ref, VM_guest_metrics ref)
Get the live field of the given VM_guest_metrics.
Parameters: session ref session_id
Reference to a valid session
VM_guest_metrics ref self
reference to the object
Minimum role: read-only
Result: value of the field
Published in: XenServer 5.0 (orlando)
True if the guest is sending heartbeat messages via the guest agent
Removed
(string → string) map
get_memory
(session ref, VM_guest_metrics ref)
Get the memory field of the given VM_guest_metrics.
Parameters: session ref session_id
Reference to a valid session
VM_guest_metrics ref self
reference to the object
Minimum role: read-only
Result: value of the field
Published in: XenServer 4.0 (rio)
free/used/total
Deprecated in: XenServer 5.5 (george)
Dummy transition
Removed in: XenServer 5.5 (george)
Disabled in favour of the RRDs, to improve scalability
Prototype
(string → string) map
get_netbios_name
(session ref, VM_guest_metrics ref)
Get the netbios_name field of the given VM_guest_metrics.
Parameters: session ref session_id
Reference to a valid session
VM_guest_metrics ref self
reference to the object
Minimum role: read-only
Result: value of the field
Prototyped in: XAPI 24.28.0 (24.28.0)
(string → string) map
get_networks
(session ref, VM_guest_metrics ref)
Get the networks field of the given VM_guest_metrics.
Parameters: session ref session_id
Reference to a valid session
VM_guest_metrics ref self
reference to the object
Minimum role: read-only
Result: value of the field
Published in: XenServer 4.0 (rio)
network configuration
(string → string) map
get_os_version
(session ref, VM_guest_metrics ref)
Get the os_version field of the given VM_guest_metrics.
Parameters: session ref session_id
Reference to a valid session
VM_guest_metrics ref self
reference to the object
Minimum role: read-only
Result: value of the field
Published in: XenServer 4.0 (rio)
version of the OS
(string → string) map
get_other
(session ref, VM_guest_metrics ref)
Get the other field of the given VM_guest_metrics.
Parameters: session ref session_id
Reference to a valid session
VM_guest_metrics ref self
reference to the object
Minimum role: read-only
Result: value of the field
Published in: XenServer 4.0 (rio)
anything else
(string → string) map
get_other_config
(session ref, VM_guest_metrics ref)
Get the other_config field of the given VM_guest_metrics.
Parameters: session ref session_id
Reference to a valid session
VM_guest_metrics ref self
reference to the object
Minimum role: read-only
Result: value of the field
Published in: XenServer 5.0 (orlando)
additional configuration
VM_guest_metrics record
get_record
(session ref, VM_guest_metrics ref)
Get a record containing the current state of the given VM_guest_metrics.
Parameters: session ref session_id
Reference to a valid session
VM_guest_metrics ref self
reference to the object
Minimum role: read-only
Result: all fields from the object
Published in: XenServer 4.0 (rio)
The metrics reported by the guest (as opposed to inferred from outside)
string
get_uuid
(session ref, VM_guest_metrics ref)
Get the uuid field of the given VM_guest_metrics.
Parameters: session ref session_id
Reference to a valid session
VM_guest_metrics ref self
reference to the object
Minimum role: read-only
Result: value of the field
Published in: XenServer 4.0 (rio)
Unique identifier/object reference
void
remove_from_other_config
(session ref, VM_guest_metrics ref, string)
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.
Parameters: session ref session_id
Reference to a valid session
VM_guest_metrics ref self
reference to the object
string key
Key to remove
Minimum role: vm-admin
Published in: XenServer 5.0 (orlando)
additional configuration
void
set_other_config
(session ref, VM_guest_metrics ref, (string → string) map)
Set the other_config field of the given VM_guest_metrics.
Parameters: session ref session_id
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
Published in: XenServer 5.0 (orlando)
additional configuration
