Class: VM_metrics
The metrics associated with a VM
| Published in: | XenServer 4.0 (rio) | The metrics associated with a VM |
Enums
domain_type
| Values: | hvm | HVM; Fully Virtualised |
| pv | PV: Paravirtualised |
| pv_in_pvh | PV inside a PVH container |
| pvh | PVH |
| unspecified | Not specified or unknown domain type |
Fields
enum domain_type
current_domain_type
[RO/runtime]
The current domain type of the VM (for running,suspended, or paused VMs). The last-known domain type for halted VMs.
| Default value: | unspecified |
| Prototyped in: | XenServer 7.4 (jura) | Not yet implemented (for future use) |
| Published in: | XenServer 7.5 (kolkata) | This field now contains valid data |
bool
hvm
[RO/runtime]
hardware virtual machine
| Default value: | false |
| Published in: | XenServer 7.1 (ely) | hardware virtual machine |
datetime
install_time
[RO/runtime]
Time at which the VM was installed
| Published in: | XenServer 4.0 (rio) | Time at which the VM was installed |
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 |
int
memory_actual
[RO/runtime]
Guest's actual memory (bytes)
| Published in: | XenServer 4.0 (rio) | Guest's actual memory (bytes) |
bool
nested_virt
[RO/runtime]
VM supports nested virtualisation
| Default value: | false |
| Published in: | XenServer 7.1 (ely) | VM supports nested virtualisation |
bool
nomigrate
[RO/runtime]
VM is immobile and can't migrate between hosts
| Default value: | false |
| Published in: | XenServer 7.1 (ely) | VM is immobile and can't migrate between hosts |
(string → string) map
other_config
[RW]
additional configuration
| Default value: | {} |
| Published in: | XenServer 5.0 (orlando) | additional configuration |
datetime
start_time
[RO/runtime]
Time at which this VM was last booted
| Published in: | XenServer 4.0 (rio) | Time at which this VM was last booted |
string set
state
[RO/runtime]
The state of the guest, eg blocked, dying etc
| Published in: | XenServer 4.0 (rio) | The state of the guest, eg blocked, dying etc |
string
uuid
[RO/runtime]
Unique identifier/object reference
| Published in: | XenServer 4.0 (rio) | Unique identifier/object reference |
(int → int) map
VCPUs_CPU
[RO/runtime]
VCPU to PCPU map
| Published in: | XenServer 4.0 (rio) | VCPU to PCPU map |
(int → string set) map
VCPUs_flags
[RO/runtime]
CPU flags (blocked,online,running)
| Published in: | XenServer 4.0 (rio) | CPU flags (blocked,online,running) |
int
VCPUs_number
[RO/runtime]
Current number of VCPUs
| Published in: | XenServer 4.0 (rio) | Current number of VCPUs |
(string → string) map
VCPUs_params
[RO/runtime]
The live equivalent to VM.VCPUs_params
| Published in: | XenServer 4.0 (rio) | The live equivalent to VM.VCPUs_params |
Removed
(int → float) map
VCPUs_utilisation
[RO/runtime]
Utilisation for all of guest's current VCPUs
| Default value: | {} |
| Published in: | XenServer 4.0 (rio) | |
| Deprecated in: | XenServer 6.1 (tampa) | Dummy transition |
| Removed in: | XenServer 6.1 (tampa) | Disabled in favour of RRDs |
Messages
void
add_to_other_config
(session ref, VM_metrics ref, string, string)
Add the given key-value pair to the other_config field of the given VM_metrics.
| Parameters: | session ref session_id | Reference to a valid session |
| VM_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 |
VM_metrics ref set
get_all
(session ref)
Return a list of all the VM_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 associated with a VM |
(VM_metrics ref → VM_metrics record) map
get_all_records
(session ref)
Return a map of VM_metrics references to VM_metrics records for all VM_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 associated with a VM |
VM_metrics ref
get_by_uuid
(session ref, string)
Get a reference to the VM_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 associated with a VM |
enum domain_type
get_current_domain_type
(session ref, VM_metrics ref)
Get the current_domain_type field of the given VM_metrics.
| Parameters: | session ref session_id | Reference to a valid session |
| VM_metrics ref self | reference to the object |
| Minimum role: | read-only |
| Result: | value of the field |
| Prototyped in: | XenServer 7.4 (jura) | Not yet implemented (for future use) |
| Published in: | XenServer 7.5 (kolkata) | This field now contains valid data |
bool
get_hvm
(session ref, VM_metrics ref)
Get the hvm field of the given VM_metrics.
| Parameters: | session ref session_id | Reference to a valid session |
| VM_metrics ref self | reference to the object |
| Minimum role: | read-only |
| Result: | value of the field |
| Published in: | XenServer 7.1 (ely) | hardware virtual machine |
datetime
get_install_time
(session ref, VM_metrics ref)
Get the install_time field of the given VM_metrics.
| Parameters: | session ref session_id | Reference to a valid session |
| VM_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 the VM was installed |
datetime
get_last_updated
(session ref, VM_metrics ref)
Get the last_updated field of the given VM_metrics.
| Parameters: | session ref session_id | Reference to a valid session |
| VM_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 |
int
get_memory_actual
(session ref, VM_metrics ref)
Get the memory/actual field of the given VM_metrics.
| Parameters: | session ref session_id | Reference to a valid session |
| VM_metrics ref self | reference to the object |
| Minimum role: | read-only |
| Result: | value of the field |
| Published in: | XenServer 4.0 (rio) | Guest's actual memory (bytes) |
bool
get_nested_virt
(session ref, VM_metrics ref)
Get the nested_virt field of the given VM_metrics.
| Parameters: | session ref session_id | Reference to a valid session |
| VM_metrics ref self | reference to the object |
| Minimum role: | read-only |
| Result: | value of the field |
| Published in: | XenServer 7.1 (ely) | VM supports nested virtualisation |
bool
get_nomigrate
(session ref, VM_metrics ref)
Get the nomigrate field of the given VM_metrics.
| Parameters: | session ref session_id | Reference to a valid session |
| VM_metrics ref self | reference to the object |
| Minimum role: | read-only |
| Result: | value of the field |
| Published in: | XenServer 7.1 (ely) | VM is immobile and can't migrate between hosts |
(string → string) map
get_other_config
(session ref, VM_metrics ref)
Get the other_config field of the given VM_metrics.
| Parameters: | session ref session_id | Reference to a valid session |
| VM_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_metrics record
get_record
(session ref, VM_metrics ref)
Get a record containing the current state of the given VM_metrics.
| Parameters: | session ref session_id | Reference to a valid session |
| VM_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 associated with a VM |
datetime
get_start_time
(session ref, VM_metrics ref)
Get the start_time field of the given VM_metrics.
| Parameters: | session ref session_id | Reference to a valid session |
| VM_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 VM was last booted |
string set
get_state
(session ref, VM_metrics ref)
Get the state field of the given VM_metrics.
| Parameters: | session ref session_id | Reference to a valid session |
| VM_metrics ref self | reference to the object |
| Minimum role: | read-only |
| Result: | value of the field |
| Published in: | XenServer 4.0 (rio) | The state of the guest, eg blocked, dying etc |
string
get_uuid
(session ref, VM_metrics ref)
Get the uuid field of the given VM_metrics.
| Parameters: | session ref session_id | Reference to a valid session |
| VM_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 |
(int → int) map
get_VCPUs_CPU
(session ref, VM_metrics ref)
Get the VCPUs/CPU field of the given VM_metrics.
| Parameters: | session ref session_id | Reference to a valid session |
| VM_metrics ref self | reference to the object |
| Minimum role: | read-only |
| Result: | value of the field |
| Published in: | XenServer 4.0 (rio) | VCPU to PCPU map |
(int → string set) map
get_VCPUs_flags
(session ref, VM_metrics ref)
Get the VCPUs/flags field of the given VM_metrics.
| Parameters: | session ref session_id | Reference to a valid session |
| VM_metrics ref self | reference to the object |
| Minimum role: | read-only |
| Result: | value of the field |
| Published in: | XenServer 4.0 (rio) | CPU flags (blocked,online,running) |
int
get_VCPUs_number
(session ref, VM_metrics ref)
Get the VCPUs/number field of the given VM_metrics.
| Parameters: | session ref session_id | Reference to a valid session |
| VM_metrics ref self | reference to the object |
| Minimum role: | read-only |
| Result: | value of the field |
| Published in: | XenServer 4.0 (rio) | Current number of VCPUs |
(string → string) map
get_VCPUs_params
(session ref, VM_metrics ref)
Get the VCPUs/params field of the given VM_metrics.
| Parameters: | session ref session_id | Reference to a valid session |
| VM_metrics ref self | reference to the object |
| Minimum role: | read-only |
| Result: | value of the field |
| Published in: | XenServer 4.0 (rio) | The live equivalent to VM.VCPUs_params |
Removed
(int → float) map
get_VCPUs_utilisation
(session ref, VM_metrics ref)
Get the VCPUs/utilisation field of the given VM_metrics.
| Parameters: | session ref session_id | Reference to a valid session |
| VM_metrics ref self | reference to the object |
| Minimum role: | read-only |
| Result: | value of the field |
| Published in: | XenServer 4.0 (rio) | |
| Deprecated in: | XenServer 6.1 (tampa) | Dummy transition |
| Removed in: | XenServer 6.1 (tampa) | Disabled in favour of RRDs |
void
remove_from_other_config
(session ref, VM_metrics ref, string)
Remove the given key and its corresponding value from the other_config field of the given VM_metrics. If the key is not in that Map, then do nothing.
| Parameters: | session ref session_id | Reference to a valid session |
| VM_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_metrics ref, (string → string) map)
Set the other_config field of the given VM_metrics.
| Parameters: | session ref session_id | Reference to a valid session |
| VM_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 |