HP BL680c XenEnterprise Management API - Page 55

Class: VM

Page 55 highlights

2.9. CLASS: VM CHAPTER 2. API REFERENCE 2.9 Class: VM 2.9.1 Fields for class: VM Name Description Quals RO run RO run RO run RO run RW RW RW RW RO run RO run RO run RW RW RW RW RW RW VM A virtual machine (or 'guest'). Field uuid allowed operations current operations power state name/label name/description user version is a template suspend VDI resident on scheduled to be resident on affinity memory/static max memory/dynamic max memory/dynamic min memory/static min VCPUs/params Type string (vm operations) Set (string → vm operations) Map vm power state string string int bool VDI ref host ref host ref host ref int int int int (string → string) Map Description unique identifier/object reference list of the operations allowed in this state. This list is advisory only and the server state may have changed by the time this field is read by a client. links each of the running tasks using this object (by reference) to a current operation enum which describes the nature of the task. Current power state of the machine a human-readable name a notes field containg humanreadable description a user version number for this machine true if this is a template. Template VMs can never be started, they are used only for cloning other VMs The VDI that a suspend image is stored on. (Only has meaning if VM is currently suspended) the host the VM is currently resident on the host on which the VM is due to be started/resumed/migrated. This acts as a memory reservation indicator a host which the VM has some affinity for (or NULL). This is used as a hint to the start call when it decides where to run the VM. Implementations are free to ignore this field. Statically-set (i.e. absolute) maximum (bytes). The value of this field at VM start time acts as a hard limit of the amount of memory a guest can use. New values only take effect on reboot. Dynamic maximum (bytes) Dynamic minimum (bytes) Statically-set (i.e. absolute) mininum (bytes). The value of this field indicates the least amount of memory this VM can boot with without crashing. configuration parameters for the selected VCPU policy 55

  • 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.9. CLASS: VM
CHAPTER 2. API REFERENCE
2.9
Class: VM
2.9.1
Fields for class: VM
Name
VM
Description
A virtual machine (or ’guest’).
Quals
Field
Type
Description
RO
run
uuid
string
unique identifier/object reference
RO
run
allowed
operations
(vm
operations) Set
list of the operations allowed in this
state. This list is advisory only and
the server state may have changed by
the time this field is read by a client.
RO
run
current
operations
(string
vm
operations) Map
links each of the running tasks using
this object (by reference) to a cur-
rent
operation enum which describes
the nature of the task.
RO
run
power
state
vm
power
state
Current power state of the machine
RW
name/label
string
a human-readable name
RW
name/description
string
a
notes
field
containg
human-
readable description
RW
user
version
int
a user version number for this ma-
chine
RW
is
a
template
bool
true if this is a template.
Template
VMs can never be started, they are
used only for cloning other VMs
RO
run
suspend
VDI
VDI ref
The VDI that a suspend image is
stored on. (Only has meaning if VM
is currently suspended)
RO
run
resident
on
host ref
the host the VM is currently resident
on
RO
run
scheduled
to
be
resident
on
host ref
the host on which the VM is due to
be started/resumed/migrated.
This
acts as a memory reservation indica-
tor
RW
affinity
host ref
a host which the VM has some affin-
ity for (or NULL). This is used as a
hint to the start call when it decides
where to run the VM. Implementa-
tions are free to ignore this field.
RW
memory/static
max
int
Statically-set (i.e.
absolute) maxi-
mum (bytes). The value of this field
at VM start time acts as a hard limit
of the amount of memory a guest can
use.
New values only take effect on
reboot.
RW
memory/dynamic
max
int
Dynamic maximum (bytes)
RW
memory/dynamic
min
int
Dynamic minimum (bytes)
RW
memory/static
min
int
Statically-set (i.e. absolute) mininum
(bytes).
The value of this field in-
dicates the least amount of memory
this VM can boot with without crash-
ing.
RW
VCPUs/params
(string
string) Map
configuration parameters for the se-
lected VCPU policy
55