2.10.
CLASS: VM METRICS
CHAPTER 2.
API REFERENCE
2.10
Class: VM metrics
2.10.1
Fields for class: VM metrics
Name
VM metrics
Description
The metrics associated with a VM.
Quals
Field
Type
Description
RO
run
uuid
string
unique identifier/object reference
RO
run
memory/actual
int
Guest’s actual memory (bytes)
RO
run
VCPUs/number
int
Current number of VCPUs
RO
run
VCPUs/utilisation
(int
→
float) Map
Utilisation for all of guest’s current
VCPUs
RO
run
VCPUs/CPU
(int
→
int) Map
VCPU to PCPU map
RO
run
VCPUs/params
(string
→
string) Map
The
live
equivalent
to
VM.VCPUs params
RO
run
VCPUs/flags
(int
→
string Set) Map
CPU flags (blocked,online,running)
RO
run
state
string Set
The state of the guest, eg blocked,
dying etc
RO
run
start time
datetime
Time at which this VM was last
booted
RO
run
install time
datetime
Time at which the VM was installed
RO
run
last updated
datetime
Time at which this information was
last updated
2.10.2
RPCs associated with class: VM metrics
RPC name: get all
Overview:
Return a list of all the VM metrics instances known to the system.
Signature:
((VM_metrics ref) Set) get_all (session_id s)
Return Type:
(VM metrics ref) Set
references to all objects
RPC name: get all records
Overview:
Return a map of VM metrics references to VM metrics records for all VM metrics instances known
to the system.
Signature:
((VM_metrics ref -> VM_metrics record) Map) get_all_records (session_id s)
Return Type:
(VM metrics ref
→
VM metrics record) Map
records of all objects
99