HP BL680c XenEnterprise Management API - Page 99

Class: VM, metrics

Page 99 highlights

2.10. CLASS: VM METRICS CHAPTER 2. API REFERENCE 2.10 Class: VM metrics 2.10.1 Fields for class: VM metrics Name Description Quals RO run RO run RO run RO run RO run RO run RO run RO run RO run RO run RO run VM metrics The metrics associated with a VM. Field Type uuid string memory/actual int VCPUs/number int VCPUs/utilisation (int → float) Map VCPUs/CPU VCPUs/params (int → int) Map (string → string) Map VCPUs/flags state (int → string Set) Map string Set start time datetime install time last updated datetime datetime Description unique identifier/object reference Guest's actual memory (bytes) Current number of VCPUs Utilisation for all of guest's current VCPUs VCPU to PCPU map The live equivalent to VM.VCPUs params CPU flags (blocked,online,running) The state of the guest, eg blocked, dying etc Time at which this VM was last booted Time at which the VM was installed 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

  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16
  • 17
  • 18
  • 19
  • 20
  • 21
  • 22
  • 23
  • 24
  • 25
  • 26
  • 27
  • 28
  • 29
  • 30
  • 31
  • 32
  • 33
  • 34
  • 35
  • 36
  • 37
  • 38
  • 39
  • 40
  • 41
  • 42
  • 43
  • 44
  • 45
  • 46
  • 47
  • 48
  • 49
  • 50
  • 51
  • 52
  • 53
  • 54
  • 55
  • 56
  • 57
  • 58
  • 59
  • 60
  • 61
  • 62
  • 63
  • 64
  • 65
  • 66
  • 67
  • 68
  • 69
  • 70
  • 71
  • 72
  • 73
  • 74
  • 75
  • 76
  • 77
  • 78
  • 79
  • 80
  • 81
  • 82
  • 83
  • 84
  • 85
  • 86
  • 87
  • 88
  • 89
  • 90
  • 91
  • 92
  • 93
  • 94
  • 95
  • 96
  • 97
  • 98
  • 99
  • 100
  • 101
  • 102
  • 103
  • 104
  • 105
  • 106
  • 107
  • 108
  • 109
  • 110
  • 111
  • 112
  • 113
  • 114
  • 115
  • 116
  • 117
  • 118
  • 119
  • 120
  • 121
  • 122
  • 123
  • 124
  • 125
  • 126
  • 127
  • 128
  • 129
  • 130
  • 131
  • 132
  • 133
  • 134
  • 135
  • 136
  • 137
  • 138
  • 139
  • 140
  • 141
  • 142
  • 143
  • 144
  • 145
  • 146
  • 147
  • 148
  • 149
  • 150
  • 151
  • 152
  • 153
  • 154
  • 155
  • 156
  • 157
  • 158
  • 159
  • 160
  • 161
  • 162
  • 163
  • 164
  • 165
  • 166
  • 167
  • 168
  • 169
  • 170
  • 171
  • 172
  • 173
  • 174
  • 175
  • 176
  • 177
  • 178
  • 179
  • 180
  • 181
  • 182
  • 183
  • 184
  • 185
  • 186
  • 187
  • 188
  • 189
  • 190
  • 191
  • 192
  • 193
  • 194
  • 195
  • 196
  • 197
  • 198
  • 199
  • 200
  • 201
  • 202
  • 203
  • 204
  • 205
  • 206
  • 207
  • 208
  • 209
  • 210
  • 211
  • 212
  • 213
  • 214
  • 215
  • 216
  • 217
  • 218
  • 219
  • 220
  • 221
  • 222
  • 223
  • 224
  • 225
  • 226
  • 227
  • 228
  • 229
  • 230
  • 231
  • 232
  • 233
  • 234
  • 235
  • 236
  • 237
  • 238
  • 239
  • 240
  • 241
  • 242
  • 243
  • 244
  • 245
  • 246
  • 247
  • 248
  • 249
  • 250
  • 251
  • 252
  • 253
  • 254
  • 255
  • 256
  • 257
  • 258
  • 259
  • 260
  • 261
  • 262
  • 263
  • 264
  • 265
  • 266
  • 267
  • 268
  • 269
  • 270
  • 271
  • 272
  • 273
  • 274
  • 275
  • 276
  • 277
  • 278
  • 279
  • 280
  • 281
  • 282
  • 283
  • 284
  • 285
  • 286
  • 287
  • 288
  • 289
  • 290
  • 291
  • 292
  • 293
  • 294
  • 295
  • 296
  • 297
  • 298
  • 299
  • 300
  • 301
  • 302
  • 303
  • 304
  • 305
  • 306
  • 307
  • 308
  • 309
  • 310
  • 311
  • 312
  • 313

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