HP BL680c XenEnterprise Management API - Page 62

Return Type, Possible Error Codes, RPC name: resume, Overview, Signature, Arguments, description,

Page 62 highlights

2.9. CLASS: VM CHAPTER 2. API REFERENCE Return Type: void Possible Error Codes: VM BAD POWER STATE, OPERATION NOT ALLOWED, VM IS TEMPLATE RPC name: resume on Overview: Awaken the specified VM and resume it on a particular Host. This can only be called when the specified VM is in the Suspended state. Signature: void resume_on (session_id s, VM ref vm, host ref host, bool start_paused, bool force) Arguments: type VM ref host ref bool bool name vm host start paused force description The VM to resume The Host on which to resume the VM Resume VM in paused state if set to true. Attempt to force the VM to resume. If this flag is false then the VM may fail pre-resume safety checks (e.g. if the CPU the VM was running on looks substantially different to the current one) Return Type: void Possible Error Codes: VM BAD POWER STATE, OPERATION NOT ALLOWED, VM IS TEMPLATE RPC name: pool migrate Overview: Migrate a VM to another Host. This can only be called when the specified VM is in the Running state. Signature: void pool_migrate (session_id s, VM ref vm, host ref host, (string -> string) Map options) Arguments: type VM ref host ref (string → string) Map name vm host options description The VM to migrate The target host Extra configuration operations Return Type: void Possible Error Codes: VM BAD POWER STATE, OTHER OPERATION IN PROGRESS, VM IS TEMPLATE, OPERATION NOT ALLOWED, VM MIGRATE FAILED, VM MISSING PV DRIVERS RPC name: set VCPUs number live Overview: Set this VM's VCPUs/at startup value, and set the same value on the VM, if running. Signature: 62

  • 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
Return Type:
void
Possible Error Codes:
VM
BAD
POWER
STATE
,
OPERATION
NOT
ALLOWED
,
VM
IS
TEMPLATE
RPC name: resume
on
Overview:
Awaken the specified VM and resume it on a particular Host. This can only be called when the
specified VM is in the Suspended state.
Signature:
void resume_on (session_id s, VM ref vm, host ref host, bool start_paused, bool force)
Arguments:
type
name
description
VM ref
vm
The VM to resume
host ref
host
The Host on which to resume the VM
bool
start
paused
Resume VM in paused state if set to true.
bool
force
Attempt to force the VM to resume.
If this
flag is false then the VM may fail pre-resume
safety checks (e.g.
if the CPU the VM was
running on looks substantially different to the
current one)
Return Type:
void
Possible Error Codes:
VM
BAD
POWER
STATE
,
OPERATION
NOT
ALLOWED
,
VM
IS
TEMPLATE
RPC name: pool
migrate
Overview:
Migrate a VM to another Host. This can only be called when the specified VM is in the Running
state.
Signature:
void pool_migrate (session_id s, VM ref vm, host ref host, (string -> string) Map options)
Arguments:
type
name
description
VM ref
vm
The VM to migrate
host ref
host
The target host
(string
string) Map
options
Extra configuration operations
Return Type:
void
Possible Error Codes:
VM
BAD
POWER
STATE
,
OTHER
OPERATION
IN
PROGRESS
,
VM
IS
TEMPLATE
,
OPERATION
NOT
ALLOWED
,
VM
MIGRATE
FAILED
,
VM
MISSING
PV
DRIVERS
RPC name: set
VCPUs
number
live
Overview:
Set this VM’s VCPUs/at
startup value, and set the same value on the VM, if running.
Signature:
62