HP BL680c XenEnterprise Management API - Page 57

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

Page 57 highlights

2.9. CLASS: VM CHAPTER 2. API REFERENCE Clones the specified VM, making a new VM. Clone automatically exploits the capabilities of the underlying storage repository in which the VM's disk images are stored (e.g. Copy on Write). This function can only be called when the VM is in the Halted State. Signature: (VM ref) clone (session_id s, VM ref vm, string new_name) Arguments: type VM ref string name description vm The VM to be cloned new name The name of the cloned VM Return Type: VM ref The reference of the newly created VM. Possible Error Codes: VM BAD POWER STATE, SR FULL, OPERATION NOT ALLOWED RPC name: copy Overview: Copied the specified VM, making a new VM. Unlike clone, copy does not exploits the capabilities of the underlying storage repository in which the VM's disk images are stored. Instead, copy guarantees that the disk images of the newly created VM will be 'full disks' - i.e. not part of a CoW chain. This function can only be called when the VM is in the Halted State. Signature: (VM ref) copy (session_id s, VM ref vm, string new_name, SR ref sr) Arguments: type VM ref string SR ref name vm new name sr description The VM to be copied The name of the copied VM An SR to copy all the VM's disks into (if an invalid reference then it uses the existing SRs) Return Type: VM ref The reference of the newly created VM. Possible Error Codes: VM BAD POWER STATE, SR FULL, OPERATION NOT ALLOWED RPC name: provision Overview: Inspects the disk configuration contained within the VM's other config, creates VDIs and VBDs and then executes any applicable post-install script. Signature: void provision (session_id s, VM ref vm) Arguments: type name description VM ref vm The VM to be provisioned 57

  • 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
Clones the specified VM, making a new VM. Clone automatically exploits the capabilities of the
underlying storage repository in which the VM’s disk images are stored (e.g.
Copy on Write).
This function can only be called when the VM is in the Halted State.
Signature:
(VM ref) clone (session_id s, VM ref vm, string new_name)
Arguments:
type
name
description
VM ref
vm
The VM to be cloned
string
new
name
The name of the cloned VM
Return Type:
VM ref
The reference of the newly created VM.
Possible Error Codes:
VM
BAD
POWER
STATE
,
SR
FULL
,
OPERATION
NOT
ALLOWED
RPC name: copy
Overview:
Copied the specified VM, making a new VM. Unlike clone, copy does not exploits the capabilities
of the underlying storage repository in which the VM’s disk images are stored.
Instead, copy
guarantees that the disk images of the newly created VM will be ’full disks’ - i.e. not part of a
CoW chain. This function can only be called when the VM is in the Halted State.
Signature:
(VM ref) copy (session_id s, VM ref vm, string new_name, SR ref sr)
Arguments:
type
name
description
VM ref
vm
The VM to be copied
string
new
name
The name of the copied VM
SR ref
sr
An SR to copy all the VM’s disks into (if an
invalid reference then it uses the existing SRs)
Return Type:
VM ref
The reference of the newly created VM.
Possible Error Codes:
VM
BAD
POWER
STATE
,
SR
FULL
,
OPERATION
NOT
ALLOWED
RPC name: provision
Overview:
Inspects the disk configuration contained within the VM’s other
config, creates VDIs and VBDs
and then executes any applicable post-install script.
Signature:
void provision (session_id s, VM ref vm)
Arguments:
type
name
description
VM ref
vm
The VM to be provisioned
57