HP BL680c XenEnterprise Management API - Page 16

Types

Page 16 highlights

2.3. TYPES CHAPTER 2. API REFERENCE 2.2.1 List of bound fields 2.3 Types 2.3.1 Primitives The following primitive types are used to specify methods and fields in the API Reference: Type String Int Float Bool DateTime Ref (object name) Description text strings 64-bit integers IEEE double-precision floating-point numbers boolean date and timestamp reference to an object of class name 2.3.2 Higher order types The following type constructors are used: Type Description List (t) an arbitrary-length list of elements of type t Map (a → b) a table mapping values of type a to values of type b 2.3.3 Enumeration types The following enumeration types are used: enum event operation add del mod An object has been created An object has been deleted An object has been modified enum console protocol vt100 rfb rdp VT100 terminal Remote FrameBuffer protocol (as used in VNC) Remote Desktop Protocol enum vbd operations attach eject insert plug unplug unplug force Attempting to attach this VBD to a VM Attempting to eject the media from this VBD Attempting to insert new media into this VBD Attempting to hotplug this VBD Attempting to hot unplug this VBD Attempting to forcibly unplug this VBD 16

  • 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.3. TYPES
CHAPTER 2. API REFERENCE
2.2.1
List of bound fields
2.3
Types
2.3.1
Primitives
The following primitive types are used to specify methods and fields in the API Reference:
Type
Description
String
text strings
Int
64-bit integers
Float
IEEE double-precision floating-point numbers
Bool
boolean
DateTime
date and timestamp
Ref (object name)
reference to an object of class name
2.3.2
Higher order types
The following type constructors are used:
Type
Description
List (t)
an arbitrary-length list of elements of type t
Map (a
b)
a table mapping values of type a to values of type b
2.3.3
Enumeration types
The following enumeration types are used:
enum event
operation
add
An object has been created
del
An object has been deleted
mod
An object has been modified
enum console
protocol
vt100
VT100 terminal
rfb
Remote FrameBuffer protocol (as used in VNC)
rdp
Remote Desktop Protocol
enum vbd
operations
attach
Attempting to attach this VBD to a VM
eject
Attempting to eject the media from this VBD
insert
Attempting to insert new media into this VBD
plug
Attempting to hotplug this VBD
unplug
Attempting to hot unplug this VBD
unplug
force
Attempting to forcibly unplug this VBD
16