HP BL680c XenEnterprise Management API - Page 56

RPCs associated with class: VM

Page 56 highlights

2.9. CLASS: VM CHAPTER 2. API REFERENCE RW RW RW RW RW RO run RO run RO run RO run RO run RW RW RW RW RW RW RW RW RW RW RW RW RO run RO run RO run RO run RO run RO run RO run VCPUs/max VCPUs/at startup actions/after shutdown actions/after reboot actions/after crash consoles VIFs VBDs crash dumps VTPMs PV/bootloader PV/kernel PV/ramdisk PV/args PV/bootloader args PV/legacy args HVM/boot policy HVM/boot params HVM/shadow multiplier platform PCI bus other config domid domarch last boot CPU flags is control domain metrics guest metrics last booted record int int on normal exit on normal exit on crash behaviour (console ref) Set (VIF ref) Set (VBD ref) Set (crashdump ref) Set (VTPM ref) Set string string string string string string string (string → string) Map float (string → string) Map string (string → string) Map int string (string → string) Map bool VM metrics ref VM guest metrics ref string RW recommendations RW xenstore data string (string → string) Map 2.9.2 RPCs associated with class: VM RPC name: clone Overview: Max number of VCPUs Boot number of VCPUs action to take after the guest has shutdown itself action to take after the guest has rebooted itself action to take if the guest crashes virtual console devices virtual network interfaces virtual block devices crash dumps associated with this VM virtual TPMs name of or path to bootloader path to the kernel path to the initrd kernel command-line arguments miscellaneous arguments for the bootloader to make Zurich guests boot HVM boot policy HVM boot params multiplier applied to the amount of shadow that will be made available to the guest platform-specific configuration PCI bus path for pass-through devices additional configuration domain ID (if available, -1 otherwise) Domain architecture (if available, null string otherwise) describes the CPU flags on which the VM was last booted true if this is a control domain (domain 0 or a driver domain) metrics associated with this VM metrics associated with the running guest marshalled value containing VM record at time of last boot, updated dynamically to reflect the runtime state of the domain An XML specification of recommended values and ranges for properties of this VM data to be inserted into the xenstore tree (/local/domain/¡domid¿/vmdata) after the VM is created. 56

  • 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
RW
VCPUs/max
int
Max number of VCPUs
RW
VCPUs/at
startup
int
Boot number of VCPUs
RW
actions/after
shutdown
on
normal
exit
action to take after the guest has
shutdown itself
RW
actions/after
reboot
on
normal
exit
action to take after the guest has re-
booted itself
RW
actions/after
crash
on
crash
behaviour
action to take if the guest crashes
RO
run
consoles
(console ref) Set
virtual console devices
RO
run
VIFs
(VIF ref) Set
virtual network interfaces
RO
run
VBDs
(VBD ref) Set
virtual block devices
RO
run
crash
dumps
(crashdump ref) Set
crash dumps associated with this VM
RO
run
VTPMs
(VTPM ref) Set
virtual TPMs
RW
PV/bootloader
string
name of or path to bootloader
RW
PV/kernel
string
path to the kernel
RW
PV/ramdisk
string
path to the initrd
RW
PV/args
string
kernel command-line arguments
RW
PV/bootloader
args
string
miscellaneous
arguments
for
the
bootloader
RW
PV/legacy
args
string
to make Zurich guests boot
RW
HVM/boot
policy
string
HVM boot policy
RW
HVM/boot
params
(string
string) Map
HVM boot params
RW
HVM/shadow
multiplier
float
multiplier applied to the amount of
shadow that will be made available
to the guest
RW
platform
(string
string) Map
platform-specific configuration
RW
PCI
bus
string
PCI bus path for pass-through de-
vices
RW
other
config
(string
string) Map
additional configuration
RO
run
domid
int
domain ID (if available, -1 otherwise)
RO
run
domarch
string
Domain
architecture
(if
available,
null string otherwise)
RO
run
last
boot
CPU
flags
(string
string) Map
describes the CPU flags on which the
VM was last booted
RO
run
is
control
domain
bool
true if this is a control domain (do-
main 0 or a driver domain)
RO
run
metrics
VM
metrics ref
metrics associated with this VM
RO
run
guest
metrics
VM
guest
metrics ref
metrics associated with the running
guest
RO
run
last
booted
record
string
marshalled
value
containing
VM
record at time of last boot, updated
dynamically to reflect the runtime
state of the domain
RW
recommendations
string
An
XML
specification
of
recom-
mended values and ranges for prop-
erties of this VM
RW
xenstore
data
(string
string) Map
data to be inserted into the xenstore
tree
(/local/domain/¡domid¿/vm-
data) after the VM is created.
2.9.2
RPCs associated with class: VM
RPC name: clone
Overview:
56