HP BL680c XenEnterprise Management API - Page 226

Class: VDI

Page 226 highlights

2.26. CLASS: VDI CHAPTER 2. API REFERENCE 2.26 Class: VDI 2.26.1 Fields for class: VDI Name Description Quals RO run RW RW RO run RO run RO ins RO run RO run RO ins RO run RO ins RW RO ins RW RO run RO run RO run RO run RO run RW RW VDI A virtual disk image. Field uuid name/label name/description allowed operations current operations SR VBDs crash dumps virtual size physical utilisation type sharable read only other config storage lock location managed missing parent xenstore data sm config Type string string string (vdi operations) Set (string → vdi operations) Map SR ref (VBD ref) Set (crashdump ref) Set int int vdi type bool bool (string → string) Map bool string bool bool VDI ref (string → string) Map (string → string) Map Description unique identifier/object reference a human-readable name a notes field containg humanreadable description list of the operations allowed in this state. This list is advisory only and the server state may have changed by the time this field is read by a client. links each of the running tasks using this object (by reference) to a current operation enum which describes the nature of the task. storage repository in which the VDI resides list of vbds that refer to this disk list of crash dumps that refer to this disk size of disk as presented to the guest (in bytes). Note that, depending on storage backend type, requested size may not be respected exactly amount of physical space that the disk image is currently taking up on the storage repository (in bytes) type of the VDI true if this disk may be shared true if this disk may ONLY be mounted read-only additional configuration true if this disk is locked at the storage level location information true if SR scan operation reported this VDI as not present on disk References the parent disk, if this VDI is part of a chain data to be inserted into the xenstore tree (/local/domain/0/backend/vbd/¡domid¿/¡device id¿/sm-data) after the VDI is at- tached. This is generally set by the SM backends on vdi attach. SM dependent data 226

  • 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.26. CLASS: VDI
CHAPTER 2. API REFERENCE
2.26
Class: VDI
2.26.1
Fields for class: VDI
Name
VDI
Description
A virtual disk image.
Quals
Field
Type
Description
RO
run
uuid
string
unique identifier/object reference
RW
name/label
string
a human-readable name
RW
name/description
string
a
notes
field
containg
human-
readable description
RO
run
allowed
operations
(vdi
operations) Set
list of the operations allowed in this
state. This list is advisory only and
the server state may have changed by
the time this field is read by a client.
RO
run
current
operations
(string
vdi
operations) Map
links each of the running tasks using
this object (by reference) to a cur-
rent
operation enum which describes
the nature of the task.
RO
ins
SR
SR ref
storage repository in which the VDI
resides
RO
run
VBDs
(VBD ref) Set
list of vbds that refer to this disk
RO
run
crash
dumps
(crashdump ref) Set
list of crash dumps that refer to this
disk
RO
ins
virtual
size
int
size of disk as presented to the guest
(in bytes). Note that, depending on
storage backend type, requested size
may not be respected exactly
RO
run
physical
utilisation
int
amount of physical space that the
disk image is currently taking up on
the storage repository (in bytes)
RO
ins
type
vdi
type
type of the VDI
RW
sharable
bool
true if this disk may be shared
RO
ins
read
only
bool
true
if
this
disk
may
ONLY
be
mounted read-only
RW
other
config
(string
string) Map
additional configuration
RO
run
storage
lock
bool
true if this disk is locked at the stor-
age level
RO
run
location
string
location information
RO
run
managed
bool
RO
run
missing
bool
true if SR scan operation reported
this VDI as not present on disk
RO
run
parent
VDI ref
References the parent disk,
if this
VDI is part of a chain
RW
xenstore
data
(string
string) Map
data
to
be
inserted
into
the
xenstore
tree
(/local/domain/0/backend/vbd/¡domid¿/¡device
id¿/sm-data) after
the
VDI
is
at-
tached.
This is generally set by the
SM backends on vdi
attach.
RW
sm
config
(string
string) Map
SM dependent data
226