HP BL680c XenEnterprise Management API - Page 2

Contents

Page 2 highlights

Contents 1 Introduction 5 1.1 RPCs associated with fields 6 1.2 RPCs associated with classes 6 1.2.1 Additional RPCs 6 1.3 Wire Protocol for Remote API Calls 7 1.3.1 Note on References vs UUIDs 8 1.3.2 Return Values/Status Codes 8 1.4 Making XML-RPC Calls 9 1.4.1 Transport Layer 9 1.4.2 Session Layer 9 1.4.3 Synchronous and Asynchronous invocation 9 1.5 Example interactive session 10 1.6 VM Lifecycle 12 1.7 VM boot parameters 12 2 API Reference 14 2.1 Classes 14 2.2 Relationships Between Classes 15 2.2.1 List of bound fields 16 2.3 Types 16 2.3.1 Primitives 16 2.3.2 Higher order types 16 2.3.3 Enumeration types 16 2.4 Class: session 21 2.4.1 Fields for class: session 21 2.4.2 RPCs associated with class: session 21 2.5 Class: task 26 2.5.1 Fields for class: task 26 2.5.2 RPCs associated with class: task 27 2.6 Class: event 35 2.6.1 Fields for class: event 35 2.6.2 RPCs associated with class: event 35 2.7 Class: pool 37 2.7.1 Fields for class: pool 37 2.7.2 RPCs associated with class: pool 37 2.8 Class: pool patch 47 2.8.1 Fields for class: pool patch 47 2.8.2 RPCs associated with class: pool patch 47 2.9 Class: VM 55 2.9.1 Fields for class: VM 55 2.9.2 RPCs associated with class: VM 56 2.10 Class: VM metrics 99 2.10.1 Fields for class: VM metrics 99 2

  • 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

Contents
1
Introduction
5
1.1
RPCs associated with fields
...............................
6
1.2
RPCs associated with classes
..............................
6
1.2.1
Additional RPCs
.................................
6
1.3
Wire Protocol for Remote API Calls
..........................
7
1.3.1
Note on References vs UUIDs
..........................
8
1.3.2
Return Values/Status Codes
..........................
8
1.4
Making XML-RPC Calls
.................................
9
1.4.1
Transport Layer
.................................
9
1.4.2
Session Layer
...................................
9
1.4.3
Synchronous and Asynchronous invocation
..................
9
1.5
Example interactive session
...............................
10
1.6
VM Lifecycle
.......................................
12
1.7
VM boot parameters
...................................
12
2
API Reference
14
2.1
Classes
...........................................
14
2.2
Relationships Between Classes
..............................
15
2.2.1
List of bound fields
................................
16
2.3
Types
...........................................
16
2.3.1
Primitives
.....................................
16
2.3.2
Higher order types
................................
16
2.3.3
Enumeration types
................................
16
2.4
Class: session
.......................................
21
2.4.1
Fields for class: session
.............................
21
2.4.2
RPCs associated with class: session
......................
21
2.5
Class: task
........................................
26
2.5.1
Fields for class: task
...............................
26
2.5.2
RPCs associated with class: task
........................
27
2.6
Class: event
........................................
35
2.6.1
Fields for class: event
..............................
35
2.6.2
RPCs associated with class: event
.......................
35
2.7
Class: pool
........................................
37
2.7.1
Fields for class: pool
...............................
37
2.7.2
RPCs associated with class: pool
........................
37
2.8
Class: pool
patch
.....................................
47
2.8.1
Fields for class: pool
patch
...........................
47
2.8.2
RPCs associated with class: pool
patch
....................
47
2.9
Class: VM
.........................................
55
2.9.1
Fields for class: VM
...............................
55
2.9.2
RPCs associated with class: VM
........................
56
2.10 Class: VM
metrics
....................................
99
2.10.1 Fields for class: VM
metrics
...........................
99
2